│ │ │
│ │ │ │ │ │
│ │ │

Spreadsheet document

│ │ │

This section contains the API’s related to the spreadsheet document storage, which │ │ │ is provided by the liborcus-spreadsheet part of this library. This liborcus-spreadsheet │ │ │ -module has dependency on the ixion library in order to perform │ │ │ +module has dependency on the ixion library in order to perform │ │ │ computation of formula cells.

│ │ │
│ │ │
    │ │ │
  • Types
    • │ │ │
  • Document
    • │ │ │
  • Sheet
    • │ │ │
  • Table and autofilter
    • │ │ │ ├── html2text {} │ │ │ │ @@ -22,15 +22,15 @@ │ │ │ │ * _C_+_+_ _A_P_I_ _r_e_f_e_r_e_n_c_e │ │ │ │ * Spreadsheet document │ │ │ │ * _V_i_e_w_ _p_a_g_e_ _s_o_u_r_c_e │ │ │ │ =============================================================================== │ │ │ │ ************ SSpprreeaaddsshheeeett ddooccuummeenntt_? ************ │ │ │ │ This section contains the API’s related to the spreadsheet document storage, │ │ │ │ which is provided by the liborcus-spreadsheet part of this library. This │ │ │ │ -liborcus-spreadsheet module has dependency on the _i_x_i_o_n library in order to │ │ │ │ +liborcus-spreadsheet module has dependency on the ixion library in order to │ │ │ │ perform computation of formula cells. │ │ │ │ * _T_y_p_e_s │ │ │ │ * _D_o_c_u_m_e_n_t │ │ │ │ * _S_h_e_e_t │ │ │ │ * _T_a_b_l_e_ _a_n_d_ _a_u_t_o_f_i_l_t_e_r │ │ │ │ * _P_i_v_o_t_ _t_a_b_l_e │ │ │ │ * _S_t_y_l_e_s │ │ ├── ./usr/share/doc/liborcus-doc/cpp/spreadsheet-doc/pivot.html │ │ │ @@ -687,15 +687,15 @@ │ │ │
    │ │ │
    │ │ │ ~pivot_collection()
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -void insert_worksheet_cache(std::string_view sheet_name, const ixion::abs_range_t &range, std::unique_ptr<pivot_cache> &&cache)
    │ │ │ +void insert_worksheet_cache(std::string_view sheet_name, const ixion::abs_range_t &range, std::unique_ptr<pivot_cache> &&cache)
    │ │ │

    Insert a new pivot cache associated with a worksheet source.

    │ │ │
    │ │ │
    Parameters:
    │ │ │
      │ │ │

    • sheet_name – name of the sheet where the source data is.

      • │ │ │

    • range – range of the source data. Note that the sheet indices are not used.

      • │ │ │

    • cache – pivot cache instance to store.

      • │ │ │ @@ -727,15 +727,15 @@ │ │ │

      number of pivot caches currently stored in the document.

      │ │ │
      │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -const pivot_cache *get_cache(std::string_view sheet_name, const ixion::abs_range_t &range) const
    │ │ │ +const pivot_cache *get_cache(std::string_view sheet_name, const ixion::abs_range_t &range) const
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ pivot_cache *get_cache(pivot_cache_id_t cache_id)
    │ │ │
    │ │ │ ├── html2text {} │ │ │ │ @@ -225,15 +225,15 @@ │ │ │ │ _p_i_v_o_t___c_a_c_h_e___i_d___t get_id() const_ │ │ │ │ const _r_e_c_o_r_d_s___t_y_p_e &get_all_records() const_ │ │ │ │ class pivot_collection_ │ │ │ │ Public Functions │ │ │ │ pivot_collection(_d_o_c_u_m_e_n_t &doc)_ │ │ │ │ ~pivot_collection()_ │ │ │ │ void insert_worksheet_cache(std::string_view sheet_name, const ixion:: │ │ │ │ - _a_b_s___r_a_n_g_e___t &range, std::unique_ptr<_p_i_v_o_t___c_a_c_h_e> &&cache)_ │ │ │ │ + abs_range_t &range, std::unique_ptr<_p_i_v_o_t___c_a_c_h_e> &&cache)_ │ │ │ │ Insert a new pivot cache associated with a worksheet source. │ │ │ │ Parameters: │ │ │ │ * sshheeeett__nnaammee – name of the sheet where the source data │ │ │ │ is. │ │ │ │ * rraannggee – range of the source data. Note that the sheet │ │ │ │ indices are not used. │ │ │ │ * ccaacchhee – pivot cache instance to store. │ │ │ │ @@ -244,14 +244,14 @@ │ │ │ │ * ttaabbllee__nnaammee – source table name. │ │ │ │ * ccaacchhee – pivot cache instance to store. │ │ │ │ size_t get_cache_count() const_ │ │ │ │ Count the number of pivot caches currently stored. │ │ │ │ Returns: │ │ │ │ number of pivot caches currently stored in the document. │ │ │ │ const _p_i_v_o_t___c_a_c_h_e *get_cache(std::string_view sheet_name, const ixion:: │ │ │ │ - _a_b_s___r_a_n_g_e___t &range) const_ │ │ │ │ + abs_range_t &range) const_ │ │ │ │ _p_i_v_o_t___c_a_c_h_e *get_cache(_p_i_v_o_t___c_a_c_h_e___i_d___t cache_id)_ │ │ │ │ const _p_i_v_o_t___c_a_c_h_e *get_cache(_p_i_v_o_t___c_a_c_h_e___i_d___t cache_id) const_ │ │ │ │ _P_r_e_v_i_o_u_s _N_e_x_t │ │ │ │ =============================================================================== │ │ │ │ © Copyright 2024, Kohei Yoshida. │ │ │ │ Built with _S_p_h_i_n_x using a _t_h_e_m_e provided by _R_e_a_d_ _t_h_e_ _D_o_c_s. │ │ ├── ./usr/share/doc/liborcus-doc/cpp/spreadsheet-doc/shared-strings.html │ │ │ @@ -143,15 +143,15 @@ │ │ │
    │ │ │
    │ │ │ shared_strings &operator=(const shared_strings&) = delete
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -shared_strings(ixion::model_context &cxt)
    │ │ │ +shared_strings(ixion::model_context &cxt)
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ ~shared_strings()
    │ │ │
    │ │ │ ├── html2text {} │ │ │ │ @@ -53,15 +53,15 @@ │ │ │ │ themselves are stored externally in the ixion::model_context instance │ │ │ │ which this class references; this class itself only stores the format │ │ │ │ properties of the rich-text strings. │ │ │ │ Public Functions │ │ │ │ shared_strings() = delete_ │ │ │ │ shared_strings(const _s_h_a_r_e_d___s_t_r_i_n_g_s&) = delete_ │ │ │ │ _s_h_a_r_e_d___s_t_r_i_n_g_s &operator=(const _s_h_a_r_e_d___s_t_r_i_n_g_s&) = delete_ │ │ │ │ - shared_strings(ixion::_m_o_d_e_l___c_o_n_t_e_x_t &cxt)_ │ │ │ │ + shared_strings(ixion::model_context &cxt)_ │ │ │ │ ~shared_strings()_ │ │ │ │ void set_format_runs(std::size_t sindex, std::unique_ptr<_f_o_r_m_a_t___r_u_n_s___t> │ │ │ │ runs)_ │ │ │ │ Set the entire format runs of a string. │ │ │ │ Parameters: │ │ │ │ * ssiinnddeexx – index of the string to associate the format │ │ │ │ runs with. │ │ ├── ./usr/share/doc/liborcus-doc/cpp/spreadsheet-doc/sheet.html │ │ │ @@ -205,25 +205,25 @@ │ │ │
    │ │ │
    │ │ │ void set_formula(row_t row, col_t col, const ixion::formula_tokens_store_ptr_t &tokens)
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -void set_formula(row_t row, col_t col, const ixion::formula_tokens_store_ptr_t &tokens, ixion::formula_result result)
    │ │ │ +void set_formula(row_t row, col_t col, const ixion::formula_tokens_store_ptr_t &tokens, ixion::formula_result result)
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -void set_grouped_formula(const range_t &range, ixion::formula_tokens_t tokens)
    │ │ │ +void set_grouped_formula(const range_t &range, ixion::formula_tokens_t tokens)
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -void set_grouped_formula(const range_t &range, ixion::formula_tokens_t tokens, ixion::formula_result result)
    │ │ │ +void set_grouped_formula(const range_t &range, ixion::formula_tokens_t tokens, ixion::formula_result result)
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ void set_col_width(col_t col, col_t col_span, col_width_t width)
    │ │ │
    │ │ │ │ │ │ @@ -320,15 +320,15 @@ │ │ │
    │ │ │
    │ │ │ void set_auto_filter_data(auto_filter_t *p)
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ -ixion::abs_range_t get_data_range() const
    │ │ │ +ixion::abs_range_t get_data_range() const
    │ │ │

    Return the smallest range that contains all non-empty cells in this sheet. The top-left corner of the returned range is always column 0 and row 0.

    │ │ │
    │ │ │
    Returns:
    │ │ │

    smallest range that contains all non-empty cells.

    │ │ │
    │ │ │
    │ │ │
    │ │ │ ├── html2text {} │ │ │ │ @@ -82,19 +82,19 @@ │ │ │ │ void set_format(_r_o_w___t row_start, _c_o_l___t col_start, _r_o_w___t row_end, _c_o_l___t │ │ │ │ col_end, size_t index)_ │ │ │ │ void set_column_format(_c_o_l___t col, _c_o_l___t col_span, std::size_t index)_ │ │ │ │ void set_row_format(_r_o_w___t row, std::size_t index)_ │ │ │ │ void set_formula(_r_o_w___t row, _c_o_l___t col, const ixion:: │ │ │ │ formula_tokens_store_ptr_t &tokens)_ │ │ │ │ void set_formula(_r_o_w___t row, _c_o_l___t col, const ixion:: │ │ │ │ - formula_tokens_store_ptr_t &tokens, ixion::_f_o_r_m_u_l_a___r_e_s_u_l_t result)_ │ │ │ │ - void set_grouped_formula(const _r_a_n_g_e___t &range, ixion::_f_o_r_m_u_l_a___t_o_k_e_n_s___t │ │ │ │ + formula_tokens_store_ptr_t &tokens, ixion::formula_result result)_ │ │ │ │ + void set_grouped_formula(const _r_a_n_g_e___t &range, ixion::formula_tokens_t │ │ │ │ tokens)_ │ │ │ │ - void set_grouped_formula(const _r_a_n_g_e___t &range, ixion::_f_o_r_m_u_l_a___t_o_k_e_n_s___t │ │ │ │ - tokens, ixion::_f_o_r_m_u_l_a___r_e_s_u_l_t result)_ │ │ │ │ + void set_grouped_formula(const _r_a_n_g_e___t &range, ixion::formula_tokens_t │ │ │ │ + tokens, ixion::formula_result result)_ │ │ │ │ void set_col_width(_c_o_l___t col, _c_o_l___t col_span, _c_o_l___w_i_d_t_h___t width)_ │ │ │ │ _c_o_l___w_i_d_t_h___t get_col_width(_c_o_l___t col, _c_o_l___t *col_start, _c_o_l___t *col_end) │ │ │ │ const_ │ │ │ │ Get column width in twips. │ │ │ │ Parameters: │ │ │ │ * ccooll – column index │ │ │ │ * ccooll__ssttaarrtt – pointer to a variable to store the index of │ │ │ │ @@ -123,15 +123,15 @@ │ │ │ │ * ccooll – column position of the upper-left cell. │ │ │ │ Returns: │ │ │ │ merged cell range. │ │ │ │ size_t get_string_identifier(_r_o_w___t row, _c_o_l___t col) const_ │ │ │ │ _a_u_t_o___f_i_l_t_e_r___t *get_auto_filter_data()_ │ │ │ │ const _a_u_t_o___f_i_l_t_e_r___t *get_auto_filter_data() const_ │ │ │ │ void set_auto_filter_data(_a_u_t_o___f_i_l_t_e_r___t *p)_ │ │ │ │ - ixion::_a_b_s___r_a_n_g_e___t get_data_range() const_ │ │ │ │ + ixion::abs_range_t get_data_range() const_ │ │ │ │ Return the smallest range that contains all non-empty cells in this │ │ │ │ sheet. The top-left corner of the returned range is always column 0 │ │ │ │ and row 0. │ │ │ │ Returns: │ │ │ │ smallest range that contains all non-empty cells. │ │ │ │ _s_h_e_e_t___t get_index() const_ │ │ │ │ _d_a_t_e___t_i_m_e___t get_date_time(_r_o_w___t row, _c_o_l___t col) const_ │ │ ├── ./usr/share/doc/liborcus-doc/cpp/spreadsheet-doc/table.html │ │ │ @@ -304,15 +304,15 @@ │ │ │ │ │ │ │ │ │
│ │ │
│ │ │

Public Members

│ │ │
│ │ │
│ │ │ -ixion::abs_range_t range
│ │ │ +ixion::abs_range_t range
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ columns_type columns
│ │ │
│ │ │ │ │ │ @@ -503,15 +503,15 @@ │ │ │
│ │ │
│ │ │ std::string_view display_name
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -ixion::abs_range_t range
│ │ │ +ixion::abs_range_t range
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ size_t totals_row_count
│ │ │
│ │ │ ├── html2text {} │ │ │ │ @@ -118,15 +118,15 @@ │ │ │ │ void swap(_a_u_t_o___f_i_l_t_e_r___t &r)_ │ │ │ │ void commit_column(_c_o_l___t col, _a_u_t_o___f_i_l_t_e_r___c_o_l_u_m_n___t data)_ │ │ │ │ Set column data to specified column index. │ │ │ │ Parameters: │ │ │ │ * ccooll – column index to associate the data to. │ │ │ │ * ddaattaa – column data. │ │ │ │ Public Members │ │ │ │ - ixion::_a_b_s___r_a_n_g_e___t range_ │ │ │ │ + ixion::abs_range_t range_ │ │ │ │ _c_o_l_u_m_n_s___t_y_p_e columns_ │ │ │ │ struct table_column_t_ │ │ │ │ Single column entry in table. │ │ │ │ Public Functions │ │ │ │ table_column_t()_ │ │ │ │ table_column_t(const _t_a_b_l_e___c_o_l_u_m_n___t &other)_ │ │ │ │ ~table_column_t()_ │ │ │ │ @@ -164,15 +164,15 @@ │ │ │ │ _t_a_b_l_e___t &operator=(const _t_a_b_l_e___t &other)_ │ │ │ │ _t_a_b_l_e___t &operator=(_t_a_b_l_e___t &&other)_ │ │ │ │ void reset()_ │ │ │ │ Public Members │ │ │ │ size_t identifier_ │ │ │ │ std::string_view name_ │ │ │ │ std::string_view display_name_ │ │ │ │ - ixion::_a_b_s___r_a_n_g_e___t range_ │ │ │ │ + ixion::abs_range_t range_ │ │ │ │ size_t totals_row_count_ │ │ │ │ _a_u_t_o___f_i_l_t_e_r___t filter_ │ │ │ │ _c_o_l_u_m_n_s___t_y_p_e columns_ │ │ │ │ _t_a_b_l_e___s_t_y_l_e___t style_ │ │ │ │ _P_r_e_v_i_o_u_s _N_e_x_t │ │ │ │ =============================================================================== │ │ │ │ © Copyright 2024, Kohei Yoshida. │ │ ├── ./usr/share/doc/liborcus-doc/overview/doc-orcus.html │ │ │ @@ -214,20 +214,20 @@ │ │ │
│ │ │

Here we assume that the string value exists for the given ID. In case you │ │ │ pass a string ID value to the get_string() method and there isn’t a string │ │ │ value associated with it, you’ll get a null pointer returned from the call.

│ │ │

The reason you need to take this 2-step process to get a string value is │ │ │ because all the string values stored in the cells are pooled at the document │ │ │ model level, and the cells themselves only store the ID values as integers.

│ │ │ -

You may also have noticed that the types surrounding the ixion::model_context │ │ │ +

You may also have noticed that the types surrounding the ixion::model_context │ │ │ class are all in the ixion namespace. It is because orcus’ own │ │ │ document class uses the formula engine and the │ │ │ document model from the ixion library to handle │ │ │ calculation of the formula cells stored in the document, and the formula engine │ │ │ -requires all cell values to be stored in the ixion::model_context │ │ │ +requires all cell values to be stored in the ixion::model_context │ │ │ instance.

│ │ │
│ │ │

Note

│ │ │

The document class in orcus uses │ │ │ the formula engine from the ixion library │ │ │ to calculate the results of the formula cells stored in the document.

│ │ │
│ │ │ ├── html2text {} │ │ │ │ @@ -124,19 +124,19 @@ │ │ │ │ std::cout << "A1: " << *s << std::endl; │ │ │ │ Here we assume that the string value exists for the given ID. In case you pass │ │ │ │ a string ID value to the get_string() method and there isn’t a string value │ │ │ │ associated with it, you’ll get a null pointer returned from the call. │ │ │ │ The reason you need to take this 2-step process to get a string value is │ │ │ │ because all the string values stored in the cells are pooled at the document │ │ │ │ model level, and the cells themselves only store the ID values as integers. │ │ │ │ -You may also have noticed that the types surrounding the _i_x_i_o_n_:_:_m_o_d_e_l___c_o_n_t_e_x_t │ │ │ │ +You may also have noticed that the types surrounding the ixion::model_context │ │ │ │ class are all in the ixion namespace. It is because orcus’ own _d_o_c_u_m_e_n_t class │ │ │ │ uses the formula engine and the document model from the _i_x_i_o_n_ _l_i_b_r_a_r_y to handle │ │ │ │ calculation of the formula cells stored in the document, and the formula engine │ │ │ │ -requires all cell values to be stored in the _i_x_i_o_n_:_:_m_o_d_e_l___c_o_n_t_e_x_t instance. │ │ │ │ +requires all cell values to be stored in the ixion::model_context instance. │ │ │ │ Note │ │ │ │ The _d_o_c_u_m_e_n_t class in orcus uses the formula engine from the _i_x_i_o_n_ _l_i_b_r_a_r_y to │ │ │ │ calculate the results of the formula cells stored in the document. │ │ │ │ The rest of the code basically repeats the same process for cells B1 and C1: │ │ │ │ pos.column = 1; // Move to B1 │ │ │ │ str_id = model.get_string_identifier(pos); │ │ │ │ s = model.get_string(str_id); │ │ ├── ./usr/share/doc/liborcus-doc/python/orcus/cell.html │ │ │ @@ -138,15 +138,15 @@ │ │ │
│ │ │ value
│ │ │

Attribute containing the value of the cell.

│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ -formula: str
│ │ │ +formula: str │ │ │

Attribute containing the formula string in case of a formula cell. This │ │ │ value will be None for a non-formula cell.

│ │ │
│ │ │ │ │ │ │ │ │ │ │ │
│ │ │ ├── html2text {} │ │ │ │ @@ -43,14 +43,14 @@ │ │ │ │ an iterator object for a formula cell. │ │ │ │ Get an iterator object for formula tokens if the cell is a formula │ │ │ │ cell. This method returns None for a non-formula cell. │ │ │ │ type:: _oo_rr_cc_uu_ss_.._CC_ee_ll_ll_TT_yy_pp_ee_ │ │ │ │ Attribute specifying the type of this cell. │ │ │ │ value_ │ │ │ │ Attribute containing the value of the cell. │ │ │ │ - formula:: _ss_tt_rr_ │ │ │ │ + formula:: ssttrr_ │ │ │ │ Attribute containing the formula string in case of a formula cell. │ │ │ │ This value will be None for a non-formula cell. │ │ │ │ _P_r_e_v_i_o_u_s _N_e_x_t │ │ │ │ =============================================================================== │ │ │ │ © Copyright 2024, Kohei Yoshida. │ │ │ │ Built with _S_p_h_i_n_x using a _t_h_e_m_e provided by _R_e_a_d_ _t_h_e_ _D_o_c_s. │ │ ├── ./usr/share/doc/liborcus-doc/python/orcus/gnumeric/index.html │ │ │ @@ -99,17 +99,17 @@ │ │ │ orcus.gnumeric.read() │ │ │

Read an Gnumeric file from a specified file path and create a │ │ │ orcus.Document instance object.

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │

  • stream – file object containing byte streams.

    • │ │ │ -

  • recalc (bool) – optional parameter specifying whether or not to recalculate │ │ │ +

  • recalc (bool) – optional parameter specifying whether or not to recalculate │ │ │ the formula cells on load. Defaults to False.

    • │ │ │ -

  • error_policy (str) – optional parameter indicating what to do when │ │ │ +

  • error_policy (str) – optional parameter indicating what to do when │ │ │ encountering formula cells with invalid formula expressions. The value │ │ │ must be either fail or skip. Defaults to fail.

    • │ │ │
│ │ │
│ │ │
Return type:
│ │ │

orcus.Document

│ │ │
│ │ │ ├── html2text {} │ │ │ │ @@ -22,17 +22,17 @@ │ │ │ │ =============================================================================== │ │ │ │ ************ oorrccuuss..ggnnuummeerriicc_? ************ │ │ │ │ orcus.gnumeric.read()_ │ │ │ │ Read an Gnumeric file from a specified file path and create a │ │ │ │ _o_r_c_u_s_._D_o_c_u_m_e_n_t instance object. │ │ │ │ Parameters: │ │ │ │ * ssttrreeaamm – file object containing byte streams. │ │ │ │ - * rreeccaallcc (_bb_oo_oo_ll) – optional parameter specifying whether or not │ │ │ │ + * rreeccaallcc (bbooooll) – optional parameter specifying whether or not │ │ │ │ to recalculate the formula cells on load. Defaults to False. │ │ │ │ - * eerrrroorr__ppoolliiccyy (_ss_tt_rr) – optional parameter indicating what to do │ │ │ │ + * eerrrroorr__ppoolliiccyy (ssttrr) – optional parameter indicating what to do │ │ │ │ when encountering formula cells with invalid formula │ │ │ │ expressions. The value must be either fail or skip. Defaults │ │ │ │ to fail. │ │ │ │ Return type: │ │ │ │ _o_r_c_u_s_._D_o_c_u_m_e_n_t │ │ │ │ Returns: │ │ │ │ document instance object that stores the content of the file. │ │ ├── ./usr/share/doc/liborcus-doc/python/orcus/named_expressions.html │ │ │ @@ -111,15 +111,15 @@ │ │ │

NamedExpressions

│ │ │
│ │ │
│ │ │ class NamedExpressions
│ │ │

Iterator for named expressions.

│ │ │
│ │ │
│ │ │ -names: set
│ │ │ +names: set │ │ │

A set of strings representing the names of the named expressions.

│ │ │
│ │ │ │ │ │
│ │ │ │ │ │ │ │ │ ├── html2text {} │ │ │ │ @@ -32,13 +32,13 @@ │ │ │ │ * _o_r_c_u_s │ │ │ │ * NamedExpressions │ │ │ │ * _V_i_e_w_ _p_a_g_e_ _s_o_u_r_c_e │ │ │ │ =============================================================================== │ │ │ │ ************ NNaammeeddEExxpprreessssiioonnss_? ************ │ │ │ │ ccllaassss NamedExpressions_ │ │ │ │ Iterator for named expressions. │ │ │ │ - names:: _ss_ee_tt_ │ │ │ │ + names:: sseett_ │ │ │ │ A set of strings representing the names of the named expressions. │ │ │ │ _P_r_e_v_i_o_u_s _N_e_x_t │ │ │ │ =============================================================================== │ │ │ │ © Copyright 2024, Kohei Yoshida. │ │ │ │ Built with _S_p_h_i_n_x using a _t_h_e_m_e provided by _R_e_a_d_ _t_h_e_ _D_o_c_s. │ │ ├── ./usr/share/doc/liborcus-doc/python/orcus/ods/index.html │ │ │ @@ -99,17 +99,17 @@ │ │ │ orcus.ods.read() │ │ │

Read an Open Document Spreadsheet file from a specified file path and create │ │ │ a orcus.Document instance object.

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │

  • stream – file object containing byte streams.

    • │ │ │ -

  • recalc (bool) – optional parameter specifying whether or not to recalculate │ │ │ +

  • recalc (bool) – optional parameter specifying whether or not to recalculate │ │ │ the formula cells on load. Defaults to False.

    • │ │ │ -

  • error_policy (str) – optional parameter indicating what to do when │ │ │ +

  • error_policy (str) – optional parameter indicating what to do when │ │ │ encountering formula cells with invalid formula expressions. The value │ │ │ must be either fail or skip. Defaults to fail.

    • │ │ │
│ │ │
│ │ │
Return type:
│ │ │

orcus.Document

│ │ │
│ │ │ ├── html2text {} │ │ │ │ @@ -22,17 +22,17 @@ │ │ │ │ =============================================================================== │ │ │ │ ************ oorrccuuss..ooddss_? ************ │ │ │ │ orcus.ods.read()_ │ │ │ │ Read an Open Document Spreadsheet file from a specified file path and │ │ │ │ create a _o_r_c_u_s_._D_o_c_u_m_e_n_t instance object. │ │ │ │ Parameters: │ │ │ │ * ssttrreeaamm – file object containing byte streams. │ │ │ │ - * rreeccaallcc (_bb_oo_oo_ll) – optional parameter specifying whether or not │ │ │ │ + * rreeccaallcc (bbooooll) – optional parameter specifying whether or not │ │ │ │ to recalculate the formula cells on load. Defaults to False. │ │ │ │ - * eerrrroorr__ppoolliiccyy (_ss_tt_rr) – optional parameter indicating what to do │ │ │ │ + * eerrrroorr__ppoolliiccyy (ssttrr) – optional parameter indicating what to do │ │ │ │ when encountering formula cells with invalid formula │ │ │ │ expressions. The value must be either fail or skip. Defaults │ │ │ │ to fail. │ │ │ │ Return type: │ │ │ │ _o_r_c_u_s_._D_o_c_u_m_e_n_t │ │ │ │ Returns: │ │ │ │ document instance object that stores the content of the file. │ │ ├── ./usr/share/doc/liborcus-doc/python/orcus/tools/bugzilla.html │ │ │ @@ -161,31 +161,31 @@ │ │ │
│ │ │
│ │ │ class orcus.tools.bugzilla.BugzillaAccess(bzurl, cache_dir)
│ │ │

Encapsulates access to a bugzilla server by using its REST API.

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │ -

  • bzurl (str) – URL to the bugzilla server.

    • │ │ │ -

  • cache_dir (pathlib.Path) – path to the cache directory.

    • │ │ │ +

  • bzurl (str) – URL to the bugzilla server.

    • │ │ │ +

  • cache_dir (pathlib.Path) – path to the cache directory.

    • │ │ │
│ │ │
│ │ │
│ │ │
│ │ │
│ │ │ get_bug_ids(bz_params)
│ │ │

Get all bug ID’s for specified bugzilla query parameters.

│ │ │
│ │ │
Parameters:
│ │ │ -

bz_params (dict) – dictionary containing all search parameters. Each search term │ │ │ +

bz_params (dict) – dictionary containing all search parameters. Each search term │ │ │ must form a single key-value pair.

│ │ │
│ │ │
│ │ │
│ │ │ -
Returns (list of str):

list of bug ID strings.

│ │ │ +
Returns (list of str):

list of bug ID strings.

│ │ │
│ │ │
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ get_attachments(bug_id)
│ │ │ ├── html2text {} │ │ │ │ @@ -63,23 +63,23 @@ │ │ │ │ finished. │ │ │ │ Default: .bugzilla │ │ │ │ --url │ │ │ │ base URL for bugzilla service. It must begin with the http(s):// prefix. │ │ │ │ ccllaassss orcus.tools.bugzilla.BugzillaAccess(bbzzuurrll, ccaacchhee__ddiirr)_ │ │ │ │ Encapsulates access to a bugzilla server by using its REST API. │ │ │ │ Parameters: │ │ │ │ - * bbzzuurrll (_ss_tt_rr) – URL to the bugzilla server. │ │ │ │ - * ccaacchhee__ddiirr (_p_a_t_h_l_i_b_._P_a_t_h) – path to the cache directory. │ │ │ │ + * bbzzuurrll (ssttrr) – URL to the bugzilla server. │ │ │ │ + * ccaacchhee__ddiirr (pathlib.Path) – path to the cache directory. │ │ │ │ get_bug_ids(bbzz__ppaarraammss)_ │ │ │ │ Get all bug ID’s for specified bugzilla query parameters. │ │ │ │ Parameters: │ │ │ │ - bbzz__ppaarraammss (_dd_ii_cc_tt) – dictionary containing all search │ │ │ │ + bbzz__ppaarraammss (ddiicctt) – dictionary containing all search │ │ │ │ parameters. Each search term must form a single key-value │ │ │ │ pair. │ │ │ │ - Returns (_l_i_s_t of _s_t_r): │ │ │ │ + Returns (list of str): │ │ │ │ list of bug ID strings. │ │ │ │ get_attachments(bbuugg__iidd)_ │ │ │ │ Fetch all attachments for specified bug. │ │ │ │ _P_r_e_v_i_o_u_s _N_e_x_t │ │ │ │ =============================================================================== │ │ │ │ © Copyright 2024, Kohei Yoshida. │ │ │ │ Built with _S_p_h_i_n_x using a _t_h_e_m_e provided by _R_e_a_d_ _t_h_e_ _D_o_c_s. │ │ ├── ./usr/share/doc/liborcus-doc/python/orcus/xls_xml/index.html │ │ │ @@ -100,17 +100,17 @@ │ │ │

Read an Excel file from a specified file path and create a │ │ │ orcus.Document instance object. The file must be saved in the │ │ │ SpreadsheetML format.

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │

  • stream – file object containing byte streams.

    • │ │ │ -

  • recalc (bool) – optional parameter specifying whether or not to recalculate │ │ │ +

  • recalc (bool) – optional parameter specifying whether or not to recalculate │ │ │ the formula cells on load. Defaults to False.

    • │ │ │ -

  • error_policy (str) – optional parameter indicating what to do when │ │ │ +

  • error_policy (str) – optional parameter indicating what to do when │ │ │ encountering formula cells with invalid formula expressions. The value │ │ │ must be either fail or skip. Defaults to fail.

    • │ │ │
│ │ │
│ │ │
Return type:
│ │ │

orcus.Document

│ │ │
│ │ │ ├── html2text {} │ │ │ │ @@ -22,17 +22,17 @@ │ │ │ │ =============================================================================== │ │ │ │ ************ oorrccuuss..xxllss__xxmmll_? ************ │ │ │ │ orcus.xls_xml.read()_ │ │ │ │ Read an Excel file from a specified file path and create a _o_r_c_u_s_._D_o_c_u_m_e_n_t │ │ │ │ instance object. The file must be saved in the SpreadsheetML format. │ │ │ │ Parameters: │ │ │ │ * ssttrreeaamm – file object containing byte streams. │ │ │ │ - * rreeccaallcc (_bb_oo_oo_ll) – optional parameter specifying whether or not │ │ │ │ + * rreeccaallcc (bbooooll) – optional parameter specifying whether or not │ │ │ │ to recalculate the formula cells on load. Defaults to False. │ │ │ │ - * eerrrroorr__ppoolliiccyy (_ss_tt_rr) – optional parameter indicating what to do │ │ │ │ + * eerrrroorr__ppoolliiccyy (ssttrr) – optional parameter indicating what to do │ │ │ │ when encountering formula cells with invalid formula │ │ │ │ expressions. The value must be either fail or skip. Defaults │ │ │ │ to fail. │ │ │ │ Return type: │ │ │ │ _o_r_c_u_s_._D_o_c_u_m_e_n_t │ │ │ │ Returns: │ │ │ │ document instance object that stores the content of the file. │ │ ├── ./usr/share/doc/liborcus-doc/python/orcus/xlsx/index.html │ │ │ @@ -100,17 +100,17 @@ │ │ │

Read an Excel file from a specified file path and create a │ │ │ orcus.Document instance object. The file must be of Excel 2007 │ │ │ XML format.

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │

  • stream – file object containing byte streams.

    • │ │ │ -

  • recalc (bool) – optional parameter specifying whether or not to recalculate │ │ │ +

  • recalc (bool) – optional parameter specifying whether or not to recalculate │ │ │ the formula cells on load. Defaults to False.

    • │ │ │ -

  • error_policy (str) – optional parameter indicating what to do when │ │ │ +

  • error_policy (str) – optional parameter indicating what to do when │ │ │ encountering formula cells with invalid formula expressions. The value │ │ │ must be either fail or skip. Defaults to fail.

    • │ │ │
│ │ │
│ │ │
Return type:
│ │ │

orcus.Document

│ │ │
│ │ │ ├── html2text {} │ │ │ │ @@ -22,17 +22,17 @@ │ │ │ │ =============================================================================== │ │ │ │ ************ oorrccuuss..xxllssxx_? ************ │ │ │ │ orcus.xlsx.read()_ │ │ │ │ Read an Excel file from a specified file path and create a _o_r_c_u_s_._D_o_c_u_m_e_n_t │ │ │ │ instance object. The file must be of Excel 2007 XML format. │ │ │ │ Parameters: │ │ │ │ * ssttrreeaamm – file object containing byte streams. │ │ │ │ - * rreeccaallcc (_bb_oo_oo_ll) – optional parameter specifying whether or not │ │ │ │ + * rreeccaallcc (bbooooll) – optional parameter specifying whether or not │ │ │ │ to recalculate the formula cells on load. Defaults to False. │ │ │ │ - * eerrrroorr__ppoolliiccyy (_ss_tt_rr) – optional parameter indicating what to do │ │ │ │ + * eerrrroorr__ppoolliiccyy (ssttrr) – optional parameter indicating what to do │ │ │ │ when encountering formula cells with invalid formula │ │ │ │ expressions. The value must be either fail or skip. Defaults │ │ │ │ to fail. │ │ │ │ Return type: │ │ │ │ _o_r_c_u_s_._D_o_c_u_m_e_n_t │ │ │ │ Returns: │ │ │ │ document instance object that stores the content of the file.