otlmow-template 1.7__py3-none-any.whl → 1.10__py3-none-any.whl

otlmow_template/SubsetTemplateCreator.py

@@ -20,8 +20,6 @@ from openpyxl.worksheet.worksheet import Worksheet
 from otlmow_converter.DotnotationHelper import DotnotationHelper
 from otlmow_converter.Exceptions.UnknownExcelError import UnknownExcelError
 from otlmow_converter.OtlmowConverter import OtlmowConverter
-from otlmow_model.OtlmowModel.BaseClasses.BooleanField import BooleanField
-from otlmow_model.OtlmowModel.BaseClasses.KeuzelijstField import KeuzelijstField
 from otlmow_model.OtlmowModel.BaseClasses.OTLObject import dynamic_create_instance_from_uri, OTLObject, \
     get_attribute_by_name, dynamic_create_type_from_uri
 from otlmow_model.OtlmowModel.Helpers.GenericHelper import get_ns_and_name_from_uri
@@ -96,6 +94,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 +108,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 +155,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 +170,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 +350,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 +362,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 +467,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 +479,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 +489,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:
@@ -487,18 +501,31 @@ class SubsetTemplateCreator:
         sheet.add_data_validation(boolean_validation)
         collected_attribute_info = []
         deprecated_attributes_row = []
+
         header_row = next(sheet.iter_rows(min_row=1, max_row=1))
+
+        first_data_row = 2 # first row is header, first data row is needed for later adjustments of formatting
+        if add_attribute_info:
+            first_data_row += 1
+        if add_deprecated and any(deprecated_attributes_row):
+            first_data_row += 1
+
+        max_row = 1000  # limit to 1000 as we only add validations up to row 1000
+        # Collect string columns to format after header processing
+        string_col_indices = []
+
         for header_cell in header_row:
             header = header_cell.value
-            if header is None or header == '':
+            if not header:
                 continue
 
             if header == 'typeURI':
                 data_validation = DataValidation(type="list", formula1=f'"{type_uri}"', allow_blank=True)
                 sheet.add_data_validation(data_validation)
-                data_validation.add(f'{header_cell.column_letter}2:{header_cell.column_letter}1000')
+                data_validation.add(f'{header_cell.column_letter}{first_data_row}:{header_cell.column_letter}{max_row}')
                 if add_attribute_info:
-                    collected_attribute_info.append('De URI van het object volgens https://www.w3.org/2001/XMLSchema#anyURI .')
+                    collected_attribute_info.append(
+                        'De URI van het object volgens https://www.w3.org/2001/XMLSchema#anyURI .')
                 if add_deprecated:
                     deprecated_attributes_row.append('')
                 continue
@@ -515,16 +542,23 @@ class SubsetTemplateCreator:
                 deprecated_attributes_row.append('DEPRECATED' if attribute.deprecated_version else '')
 
             if generate_choice_list:
-                if issubclass(attribute.field, BooleanField):
-                    boolean_validation.add(f'{header_cell.column_letter}2:{header_cell.column_letter}1000')
+                if attribute.field.native_type == bool:
+                    boolean_validation.add(f'{header_cell.column_letter}{first_data_row}:{header_cell.column_letter}{max_row}')
                     cls.color_choice_lists_green(sheet=sheet, header_cell_column=header_cell)
-
-                elif issubclass(attribute.field, KeuzelijstField):
+                elif hasattr(attribute.field, 'options') and attribute.field.options is not None:
                     cls.generate_choice_list_in_excel(
                         attribute=attribute, choice_list_dict=choice_list_dict, column=header_cell.column,
                         row_nr=1, sheet=sheet, workbook=workbook)
                     cls.color_choice_lists_green(sheet=sheet, header_cell_column=header_cell)
 
+            if attribute.field.native_type == str:
+                string_col_indices.append(header_cell.column)
+
+        # Efficiently format all string columns in one pass
+        for col_idx in string_col_indices:
+            for row_idx in range(first_data_row, max_row + 1):
+                sheet.cell(row=row_idx, column=col_idx).number_format = "@"
+
         if dummy_data_rows == 0:
             instance_count = len([x for x in instances if x.typeURI == type_uri])
             if instance_count > 0:
@@ -538,6 +572,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,
@@ -646,3 +683,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.7.dist-info → otlmow_template-1.10.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: otlmow_template
-Version: 1.7
+Version: 1.10
 Author-email: David Vlaminck <david.vlaminck@mow.vlaanderen.be>, Jasper Berton <jasperberton1@telenet.be>
 License:                     GNU GENERAL PUBLIC LICENSE
                                Version 3, 29 June 2007
@@ -684,6 +684,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Operating System :: OS Independent
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
@@ -698,12 +699,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 +733,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.10.dist-info/RECORD

@@ -0,0 +1,7 @@
+otlmow_template/SubsetTemplateCreator.py,sha256=t96Medun2k2zbTCCFSY4vKvIy43Hh4LnB1bYex5ONok,35500
+otlmow_template/Exceptions/MissingTypeUriException.py,sha256=DSKwywmP9Bq8n7rzBoDcEPlxvC1IChx18QIHFUCTtdA,51
+otlmow_template-1.10.dist-info/licenses/LICENSE,sha256=ixuiBLtpoK3iv89l7ylKkg9rs2GzF9ukPH7ynZYzK5s,35148
+otlmow_template-1.10.dist-info/METADATA,sha256=PiAyWmgjyGjipqsjg0UO4MDOISBGeznaM2GmsB3jQzg,44392
+otlmow_template-1.10.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+otlmow_template-1.10.dist-info/top_level.txt,sha256=zPgBoaTLG-avoOLySlwOUEtHaFyA5Vc5wJqkSeX1l6A,16
+otlmow_template-1.10.dist-info/RECORD,,

{otlmow_template-1.7.dist-info → otlmow_template-1.10.dist-info}/WHEEL

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

otlmow_template-1.7.dist-info/RECORD

@@ -1,7 +0,0 @@
-otlmow_template/SubsetTemplateCreator.py,sha256=M3CIHzj7u9N73J8F7L0xAt4l_M6g5Hjdz5puqvBfBnU,33233
-otlmow_template/Exceptions/MissingTypeUriException.py,sha256=DSKwywmP9Bq8n7rzBoDcEPlxvC1IChx18QIHFUCTtdA,51
-otlmow_template-1.7.dist-info/licenses/LICENSE,sha256=ixuiBLtpoK3iv89l7ylKkg9rs2GzF9ukPH7ynZYzK5s,35148
-otlmow_template-1.7.dist-info/METADATA,sha256=Stvx0Ptymrj1wVjz8Cp4yU2jqJuaFTHKRAA673O0WjY,44220
-otlmow_template-1.7.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-otlmow_template-1.7.dist-info/top_level.txt,sha256=zPgBoaTLG-avoOLySlwOUEtHaFyA5Vc5wJqkSeX1l6A,16
-otlmow_template-1.7.dist-info/RECORD,,