1.10.0

[MariusWirtz]

Highlights

Performance improvements on all major TM1 I/O functions.

from TM1py import TM1Service

with TM1Service(address="", port=12354, ssl=True, user="admin", password="") as tm1:

    df = tm1.cells.execute_view_dataframe(cube_name="Sales", view_name="Default", private=False)

	Time	State	SalesMeasure	Value
0	202001	CA	Gross Margin	13924.8
1	202001	CA	Revenue	41330.4
2	202001	CA	COGS	27405.6

from TM1py import TM1Service

with TM1Service(base_url="https://localhost:12354", user="admin", password="") as tm1:

    cells = {
        ('Belgium', 'Actual', '2022', 'Apr', 'Revenue'): 10_000,
        ('Belgium', 'Actual', '2022', 'May', 'Revenue'): 15_000,
        ...
        ('Belgium', 'Actual', '2022', 'Jun', 'Revenue'): 20_000,
        ('Belgium', 'Actual', '2022', 'Apr', 'Revenue'): 45_000,
    }

    tm1.cells.write_async(cube_name="Sales", cells=cells, slice_size=32_000, max_workers=4,
                          measure_dimension_elements={'Revenue': 'Numeric'})

Full support for TM1's git deployment functionality. Including the TM1Project and deployment definitions.

with TM1Service(address="", port=11247, ssl=True, user="admin", password="") as tm1:

    project = TM1Project(name="Project Definition")

    dev_deployment = TM1ProjectDeployment(
        deployment_name="Dev",
        settings={"ServerName": "dev"})

    dev_deployment.add_task(TM1ProjectTask(
        task_name="Security Refresh",
        process="Bedrock.Security.Refresh"))

    dev_deployment.include_all_attribute_dimensions(tm1)
    dev_deployment.add_ignore(object_class="Cubes", object_name="*")

    project.add_deployment(deployment=dev_deployment)

    tm1.git.tm1project_put(project)

New and more efficient ways to query and control elements and hierarchies.

from TM1py import TM1Service

with TM1Service(base_url="https://localhost:12354", user="admin", password="") as tm1:

    # break edge as one tiny atomic operation
    tm1.elements.remove_edge(dimension_name="Region", hierarchy_name="Region", parent="EU", component="UK")

    # add new edge as one tiny atomic operation
    tm1.elements.add_edges(dimension_name="Region", hierarchy_name="Region", edges={("Other", "UK"): 1})

from TM1py import TM1Service

with TM1Service(base_url="https://localhost:12354", user="admin", password="") as tm1:

    is_parent = tm1.elements.element_is_parent(dimension_name="Region", hierarchy_name="Region", parent_name="Other",
                                               element_name="UK")

    is_ancestor = tm1.elements.element_is_ancestor(dimension_name="Region", hierarchy_name="Region",
                                                   element_name="Other", ancestor_name="UK")

Heaps of miscellaneous features, optimizations and improvements that make your life easier when doing TM1 with Python.

from TM1py import TM1Service

with TM1Service(base_url="https://localhost:12354", user="admin", password="") as tm1:

    process_names = tm1.processes.search_string_in_code(search_string="Sunrise", skip_control_processes=True)

from TM1py import TM1Service

with TM1Service(base_url="https://localhost:12354", user="admin", password="") as tm1:

    tm1.cubes.cube_save_data("Sales")

New Features and Improvements

• Fix in set_time function in ChoreStartTime class to allow 0 values by @samuelko123 in Fix set_time of ChoreStartTime class #686
• Add substitute_title function to MDXView by @MariusWirtz in Add substitute_title function to MDXView #687
• Add include_headers argument to extract_cellset_csv function by to @MariusWirtz in Add include_headers argument #689
• Add remove_edge function to ElementService to break individual parent-child relationship in one operation by @MariusWirtz in Add remove_edge function to ElementService #693
• Fix bug to allow dimension creation from JSON file by @MariusWirtz in Necassary changes to create dim from json file #698
• Improve performance of critical build_cellset_from_pandas_dataframe function by @Kevin-Dekker in perf: improve performance of build_cellset_from_pandas_dataframe #695
• Add get_parents function to ElementService. Allows retrieval of all parents for an element by @MariusWirtz in Add get_parents function to ElementService #699
• Fix doubled double quotes issue in element names by @MariusWirtz in Fix doubled double quotes in response #704
• Explicitly add elements to leaves hierarchy so solve Additional elements in Leaves Hierarchy #702 by @MariusWirtz in Explicitly add elements to leaves hierarchy #703
• Handle duplicates in write_dataframe appropriately by @MariusWirtz in handle duplicates in write_dataframe #708 & Handle duplictes in df to dict transformation #712
• Accept str for rules update on Cube object by @MariusWirtz in Accept str for rules update on Cube object #710
• New search function to find substrings in Rules or Processes (e.g., search_string_in_code) by @adscheevel in Cube Rule search function and new skip_control parameters #723
• Fix write failure for element names with : by @MariusWirtz in Split hierarchy and element name with maxsplit=1 #724
• Add get_element_principal_name function by @MaaYuu in Add get_element_principal_name function #731
• Add get_ancestors, get_descendants functions on Hierarchy by @MariusWirtz in get_ancestors, get_descendants on Hierarchy #732
• Read 'NA' element name as a string instead of pandas NaN by @MariusWirtz in Don't read 'NA' in element names as pandas NaN #739
• Align float numbers intelligently when writing through unbound processes, to avoid "Number too big" TI errors during writeback, by @pbuncik in Alignment of float numbers when writing back through unbound process #749
• Add functions to find views that contain a specified subset by @adscheevel in View subset search #751
• Improve write_async performance by exposing measure_dimension_elements to write_async function by @MariusWirtz in Expose measure_dimension_elements in write_async #753
• Introduce get_descendant_edges function in Hierarchy class by @skriptmeister42 in Update Hierarchy.py #760
• Fix the update function in ApplicationService to use the update operation instead of the delete and recreate approach, to avoid breaking existing references of the application by @jrobinsonLOR in Add update to patch file #762
• Implement element_is_parent and element_is_ancestor by @rclapp in Feature element functions #767 and Update Element Parent and Ancestor methods #771
• Allow queries with selection on more than 3 axes in the execute_mdx function by @MariusWirtz in Allow multi axes queries in execute_mdx function #777
• Add support for trace_cell_calculation, trace_cell_feeders, and check_cell_feeders by @rclapp in Added support for trace calculations, trace feeders, and check feeders #780
• Add function create_many in AnnotationService to create many annotations in one operation by @MariusWirtz in Create many annotations #785
• Add new element functions like get_consolidated_elements, get_parents_of_all_elements by @adscheevel in Element functions #792
• Adjust TM1py to changes in mdxpy 0.4 by @MariusWirtz in Adjust TM1py to changes in mdxpy 0.4 #793
• Handle TM1Project in the GitService by @nicolasbisurgi in Adding tm1project to the Git service #775 and Rename stuff in GitProject GitService #796
• Refactor Breakpoints and introduce new debugging functionality by @adscheevel in Breakpoint refactor & new functions #791
• Allow alternative separators for elements in get_value and other functions by @tobiaskapser in Add alternative separators to get_value function #801 and Add alternative separators for element strings of the remaining functions in CellService #805
• Use 100k max statements in write function with use_ti=True by @MariusWirtz in Use 100k max statements in write use_ti #808
• Enable TCP keepalive option for long run requests by @macsir in Enable TCP keepalive option for executing long-run requests #807
• Additional features in ServerService : CubeSaveData and DeleteAllPersistentFeeders by @Mr-SabyasachiBose in Additional features - CubeSaveData and DeleteAllPersistentFeeders #810

New Contributors

• @samuelko123 made their first contribution in Fix set_time of ChoreStartTime class #686
• @Kevin-Dekker made their first contribution in perf: improve performance of build_cellset_from_pandas_dataframe #695
• @MaaYuu made their first contribution in Add get_element_principal_name function #731
• @pbuncik made their first contribution in Alignment of float numbers when writing back through unbound process #749
• @skriptmeister42 made their first contribution in Update Hierarchy.py #760
• @jrobinsonLOR made their first contribution in Add update to patch file #762
• @nicolasbisurgi made their first contribution in Adding tm1project to the Git service #775
• @tobiaskapser made their first contribution in Add alternative separators to get_value function #801
• @Mr-SabyasachiBose made their first contribution in Additional features - CubeSaveData and DeleteAllPersistentFeeders #810

How to upgrade TM1py

To upgrade TM1py, just use the following command:

pip install TM1py --upgrade

Full Changelog: 1.9.0...1.10.0

---

This discussion was created from the release 1.10.0.

[MariusWirtz]

I think this was the biggest release we have done so far, in terms of lines of code. Happy to see so many new contributors!

Nice work everyone :)

[rclapp]

Awesome job 👍

…

Sent from my mobile device On Oct 10, 2022 10:09 AM, Marius Wirtz ***@***.***> wrote: I think this was the biggest release we have done so far, in terms of lines of code. Happy to see so many new contributors! Nice work everyone :) — Reply to this email directly, view it on GitHub<#811 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AEK7GZTXXCEJUAXDOCRRJJTWCQO57ANCNFSM6AAAAAARBMCL5M>. You are receiving this because you were mentioned.Message ID: ***@***.***>

[macsir]

Yes, nice. It is a team work and the community is growing faster! Get Outlook for iOS<https://aka.ms/o0ukef>

…

________________________________ From: Ryan Clapp ***@***.***> Sent: Tuesday, October 11, 2022 5:21:16 AM To: cubewise-code/tm1py ***@***.***> Cc: tm1sir ***@***.***>; Mention ***@***.***> Subject: Re: [cubewise-code/tm1py] 1.10.0 (Discussion #811) Awesome job 👍

Sent from my mobile device On Oct 10, 2022 10:09 AM, Marius Wirtz ***@***.***> wrote: I think this was the biggest release we have done so far, in terms of lines of code. Happy to see so many new contributors! Nice work everyone :) — Reply to this email directly, view it on GitHub<#811 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AEK7GZTXXCEJUAXDOCRRJJTWCQO57ANCNFSM6AAAAAARBMCL5M>. You are receiving this because you were mentioned.Message ID: ***@***.***> — Reply to this email directly, view it on GitHub<#811 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AAZQV7JN5MEF2GLRNUDUEIDWCRUCZANCNFSM6AAAAAARBMCL5M>. You are receiving this because you were mentioned.Message ID: ***@***.***>

[zsoltmoravcsik]

Awsome Job guys!!!

…

On 2022. Oct 10., Mon at 21:21, Ryan Clapp ***@***.***> wrote: Awesome job 👍 Sent from my mobile device On Oct 10, 2022 10:09 AM, Marius Wirtz ***@***.***> wrote: I think this was the biggest release we have done so far, in terms of lines of code. Happy to see so many new contributors! Nice work everyone :) — Reply to this email directly, view it on GitHub< #811 (comment)>, or unsubscribe< https://github.com/notifications/unsubscribe-auth/AEK7GZTXXCEJUAXDOCRRJJTWCQO57ANCNFSM6AAAAAARBMCL5M>. You are receiving this because you were mentioned.Message ID: ***@***.***> — Reply to this email directly, view it on GitHub <#811 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AHNEK3C5A3QJSHWWWVR62JTWCRUDBANCNFSM6AAAAAARBMCL5M> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>