otlmow-template 1.6__py3-none-any.whl → 1.9__py3-none-any.whl

otlmow_template/SubsetTemplateCreator.py

@@ -96,6 +96,11 @@ class SubsetTemplateCreator:
             add_geometry=add_geometry, filter_attributes_by_subset=filter_attributes_by_subset,
             dummy_data_rows=dummy_data_rows, model_directory=model_directory)
 
+        abbreviate_excel_after = False
+        if kwargs.get('abbreviate_excel_sheettitles') == True:
+            kwargs['abbreviate_excel_sheettitles'] = False
+            abbreviate_excel_after = True
+
         # write the file
         await OtlmowConverter.from_objects_to_file_async(
             file_path=template_file_path, sequence_of_objects=objects, split_per_type=split_per_type, **kwargs)
@@ -105,7 +110,8 @@ class SubsetTemplateCreator:
         if extension == '.xlsx':
             await cls.alter_excel_template_async(
                 generate_choice_list=generate_choice_list, file_path=template_file_path, dummy_data_rows=dummy_data_rows,
-                instances=objects, add_deprecated=add_deprecated, add_attribute_info=add_attribute_info)
+                instances=objects, add_deprecated=add_deprecated, add_attribute_info=add_attribute_info,
+                abbreviate_excel_sheettitles=abbreviate_excel_after)
 
         elif extension == '.csv':
             await cls.alter_csv_template_async(
@@ -151,6 +157,11 @@ class SubsetTemplateCreator:
             add_geometry=add_geometry, filter_attributes_by_subset=filter_attributes_by_subset,
             dummy_data_rows=dummy_data_rows, model_directory=model_directory)
 
+        abbreviate_excel_after = False
+        if kwargs.get('abbreviate_excel_sheettitles') == True:
+            kwargs['abbreviate_excel_sheettitles'] = False
+            abbreviate_excel_after = True
+
         # write the file
         OtlmowConverter.from_objects_to_file(
             file_path=template_file_path, sequence_of_objects=objects, split_per_type=split_per_type,
@@ -161,7 +172,8 @@ class SubsetTemplateCreator:
         if extension == '.xlsx':
             cls.alter_excel_template(
                 generate_choice_list=generate_choice_list, file_path=template_file_path, dummy_data_rows=dummy_data_rows,
-                instances=objects, add_deprecated=add_deprecated, add_attribute_info=add_attribute_info)
+                instances=objects, add_deprecated=add_deprecated, add_attribute_info=add_attribute_info,
+                abbreviate_excel_sheettitles=abbreviate_excel_after)
         elif extension == '.csv':
             cls.alter_csv_template(
                 split_per_type=split_per_type, file_path=template_file_path, dummy_data_rows=dummy_data_rows,
@@ -340,7 +352,8 @@ class SubsetTemplateCreator:
 
     @classmethod
     def alter_excel_template(cls, instances: list, file_path: Path, add_attribute_info: bool,
-                             generate_choice_list: bool, dummy_data_rows: int, add_deprecated: bool):
+                             generate_choice_list: bool, dummy_data_rows: int, add_deprecated: bool,
+                             abbreviate_excel_sheettitles: bool):
         wb = load_workbook(file_path)
         wb.create_sheet('Keuzelijsten')
 
@@ -351,7 +364,8 @@ class SubsetTemplateCreator:
 
             cls.alter_excel_sheet(add_attribute_info=add_attribute_info, choice_list_dict=choice_list_dict,
                                   generate_choice_list=generate_choice_list, dummy_data_rows=dummy_data_rows,
-                                  instances=instances, sheet=sheet, add_deprecated=add_deprecated, workbook=wb)
+                                  instances=instances, sheet=sheet, add_deprecated=add_deprecated, workbook=wb,
+                                  abbreviate_excel_sheettitle=abbreviate_excel_sheettitles)
 
         wb.save(file_path)
         wb.close()
@@ -455,7 +469,8 @@ class SubsetTemplateCreator:
 
     @classmethod
     async def alter_excel_template_async(cls, instances: list, file_path: Path, add_attribute_info: bool,
-                             generate_choice_list: bool, dummy_data_rows: int, add_deprecated: bool):
+                                         generate_choice_list: bool, dummy_data_rows: int, add_deprecated: bool,
+                                         abbreviate_excel_sheettitles: bool):
         wb = load_workbook(file_path)
         wb.create_sheet('Keuzelijsten')
 
@@ -466,7 +481,8 @@ class SubsetTemplateCreator:
 
             cls.alter_excel_sheet(add_attribute_info=add_attribute_info, choice_list_dict=choice_list_dict,
                                   generate_choice_list=generate_choice_list, dummy_data_rows=dummy_data_rows,
-                                  instances=instances, sheet=sheet, add_deprecated=add_deprecated, workbook=wb)
+                                  instances=instances, sheet=sheet, add_deprecated=add_deprecated, workbook=wb,
+                                  abbreviate_excel_sheettitle=abbreviate_excel_sheettitles)
             await sleep(0)
 
         wb.save(file_path)
@@ -475,7 +491,7 @@ class SubsetTemplateCreator:
     @classmethod
     def alter_excel_sheet(cls, add_attribute_info: bool, choice_list_dict: dict, generate_choice_list: bool,
                           instances: [OTLObject], sheet: Worksheet, add_deprecated: bool, workbook: Workbook,
-                          dummy_data_rows: int):
+                          dummy_data_rows: int, abbreviate_excel_sheettitle: bool = True):
         type_uri = cls.get_uri_from_sheet_name(sheet.title)
         instance = next((x for x in instances if x.typeURI == type_uri), None)
         if instance is None:
@@ -483,7 +499,7 @@ class SubsetTemplateCreator:
         if instance is None:
             raise UnknownExcelError(f'When creating a template, no instance could be created for {type_uri}')
 
-        boolean_validation = DataValidation(type="list", formula1='"TRUE,FALSE,"', allow_blank=True)
+        boolean_validation = DataValidation(type="list", formula1='"TRUE,FALSE,-"', allow_blank=True)
         sheet.add_data_validation(boolean_validation)
         collected_attribute_info = []
         deprecated_attributes_row = []
@@ -538,6 +554,9 @@ class SubsetTemplateCreator:
 
         cls.set_fixed_column_width(sheet=sheet, width=25)
 
+        if abbreviate_excel_sheettitle:
+            cls.abbreviate_excel_sheettitle(sheet=sheet)
+
     @classmethod
     def color_choice_lists_green(cls, sheet: Worksheet, header_cell_column: Cell):
         for cell in sheet.iter_rows(min_col=header_cell_column.column, max_col=header_cell_column.column,
@@ -573,7 +592,7 @@ class SubsetTemplateCreator:
                                          options=choice_list_values, choice_list_dict=choice_list_dict)
         column_in_choice_sheet = choice_list_dict[attribute.field.naam]
         start_range = f"${column_in_choice_sheet}$2"
-        end_range = f"${column_in_choice_sheet}${len(choice_list_values) + 1}"
+        end_range = f"${column_in_choice_sheet}${len(choice_list_values) + 2}"
         data_val = DataValidation(type="list", formula1=f"Keuzelijsten!{start_range}:{end_range}",
                                   allowBlank=True)
         sheet.add_data_validation(data_val)
@@ -603,7 +622,9 @@ class SubsetTemplateCreator:
         if new_header.value is not None:
             raise ValueError(f'Header already exists at column {column_nr}: {new_header.value}')
         new_header.value = name
-        for index, option in enumerate(options, start=1):
+        cell = active_sheet.cell(row=row_nr + 1, column=column_nr)
+        cell.value = "-"
+        for index, option in enumerate(options, start=2):
             cell = active_sheet.cell(row=row_nr + index, column=column_nr)
             cell.value = option.invulwaarde
 
@@ -644,3 +665,16 @@ class SubsetTemplateCreator:
                                                             target=doel_instance, model_directory=model_directory)
 
                     otl_objects.append(relation_instance)
+
+    @classmethod
+    def abbreviate_excel_sheettitle(cls, sheet):
+        class_name = sheet.title
+        # abbreviates the class_name so it doesn't exceed the 31 character limit of sheet titles in excel
+        if '#' not in class_name:
+            sheet.title = class_name[:31]
+            return
+        split_name = class_name.split("#")
+        namespace_name = split_name[0]
+        subclass_name = split_name[1]
+        class_name = f"{namespace_name[:3]}#{subclass_name}"
+        sheet.title = class_name[:31]

{otlmow_template-1.6.dist-info → otlmow_template-1.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: otlmow_template
-Version: 1.6
+Version: 1.9
 Author-email: David Vlaminck <david.vlaminck@mow.vlaanderen.be>, Jasper Berton <jasperberton1@telenet.be>
 License:                     GNU GENERAL PUBLIC LICENSE
                                Version 3, 29 June 2007
@@ -698,12 +698,13 @@ Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: otlmow-converter>=1.14
-Requires-Dist: otlmow-modelbuilder>=0.27
+Requires-Dist: otlmow-modelbuilder>=0.37
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
 Requires-Dist: pytest-cov; extra == "test"
 Requires-Dist: pytest-subtests; extra == "test"
 Requires-Dist: pytest-timeout; extra == "test"
+Requires-Dist: pytest-asyncio; extra == "test"
 Dynamic: license-file
 
 # OTLMOW-Template
@@ -731,16 +732,18 @@ It is split into different packages to reduce compatibility issues
 - [otlmow_gui](https://github.com/davidvlaminck/OTLMOW-GUI)
 
 ## Installation and requirements
-Currently, you need at least Python version 3.8 to use this library.
-
-To install the OTL MOW project into your Python project, use pip to install it:
+I recommend working with uv. Install this first:
 ``` 
-pip install otlmow_template
+pip install uv
 ```
-To upgrade an existing installation use:
+Then install this package by using the uv pip install command:
 ``` 
-pip install otlmow_template --upgrade
+uv pip install otlmow-template
 ```
+If you are a developer, use this command to install the dependencies, including those needed to run the test suite.
+``` 
+uv pip install -r pyproject.toml --extra test
+``` 
 
 ## Usage
 #TODO

otlmow_template-1.9.dist-info/RECORD

@@ -0,0 +1,7 @@
+otlmow_template/SubsetTemplateCreator.py,sha256=dWzMZaBmJqK_k2J7ouyZyd_TovVRKPbpco47y6uc7Hk,34777
+otlmow_template/Exceptions/MissingTypeUriException.py,sha256=DSKwywmP9Bq8n7rzBoDcEPlxvC1IChx18QIHFUCTtdA,51
+otlmow_template-1.9.dist-info/licenses/LICENSE,sha256=ixuiBLtpoK3iv89l7ylKkg9rs2GzF9ukPH7ynZYzK5s,35148
+otlmow_template-1.9.dist-info/METADATA,sha256=YK9C8pnQbWaCUge2I_3pCtXVJLt4aW9d8e82wnurCxE,44340
+otlmow_template-1.9.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+otlmow_template-1.9.dist-info/top_level.txt,sha256=zPgBoaTLG-avoOLySlwOUEtHaFyA5Vc5wJqkSeX1l6A,16
+otlmow_template-1.9.dist-info/RECORD,,

{otlmow_template-1.6.dist-info → otlmow_template-1.9.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.8.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

otlmow_template-1.6.dist-info/RECORD

@@ -1,7 +0,0 @@
-otlmow_template/SubsetTemplateCreator.py,sha256=yvRxRRmOnWrMdyALG9q3HaADoQwiUh-sTki7Ui_oudM,33140
-otlmow_template/Exceptions/MissingTypeUriException.py,sha256=DSKwywmP9Bq8n7rzBoDcEPlxvC1IChx18QIHFUCTtdA,51
-otlmow_template-1.6.dist-info/licenses/LICENSE,sha256=ixuiBLtpoK3iv89l7ylKkg9rs2GzF9ukPH7ynZYzK5s,35148
-otlmow_template-1.6.dist-info/METADATA,sha256=yL3w0hRhDAYHBDBy56HFy-BMuCXBj3w5vP-tbERc478,44220
-otlmow_template-1.6.dist-info/WHEEL,sha256=zaaOINJESkSfm_4HQVc5ssNzHCPXhJm0kEUakpsEHaU,91
-otlmow_template-1.6.dist-info/top_level.txt,sha256=zPgBoaTLG-avoOLySlwOUEtHaFyA5Vc5wJqkSeX1l6A,16
-otlmow_template-1.6.dist-info/RECORD,,