kernpy 1.0.1__py3-none-any.whl → 1.0.2__py3-none-any.whl

kernpy/core/exporter.py

@@ -153,7 +153,7 @@ class HeaderTokenGenerator:
     """
     HeaderTokenGenerator class.
 
-    This class is used to translate the HeaderTokens to the specific tokenizer format.
+    This class is used to translate the HeaderTokens to the specific encoding format.
     """
     @classmethod
     def new(cls, *, token: HeaderToken, type: Encoding):
@@ -162,7 +162,7 @@ class HeaderTokenGenerator:
 
         Args:
             token (HeaderToken): The HeaderToken to be translated.
-            type (Encoding): The tokenizer to be used.
+            type (Encoding): The encoding to be used.
 
         Examples:
             >>> header = HeaderToken('**kern', 0)

kernpy/core/tokenizers.py

@@ -18,7 +18,7 @@ class Encoding(Enum):  # TODO: Eventually, polymorphism will be used to export d
         >>> doc, _ = kp.load('path/to/file.krn')
         >>>
         >>> # Save the file using the specified encoding
-        >>> exported_content = kp.dumps(tokenizer=kp.Encoding.normalizedKern)
+        >>> exported_content = kp.dumps(encoding=kp.Encoding.normalizedKern)
     """
     eKern = 'ekern'
     normalizedKern = 'kern'

kernpy/io/public.py

@@ -12,7 +12,9 @@ from kernpy import Encoding
 from kernpy.core import (
     Document, Importer, Exporter, ExportOptions, GraphvizExporter,
     generic,
-    TokenCategoryHierarchyMapper)
+    TokenCategoryHierarchyMapper,
+    TokenCategory,
+)
 
 
 def load(fp: Union[str, Path], *, raise_on_errors: Optional[bool] = False, **kwargs) -> (Document, List[str]):
@@ -84,13 +86,13 @@ def loads(s, *, raise_on_errors: Optional[bool] = False, **kwargs) -> (Document,
 
 
 def dump(document: Document, fp: Union[str, Path], *,
-         spine_types: [] = None,
-         include: [] = None,
-         exclude: [] = None,
+         spine_types: [str] = None,
+         include: [TokenCategory] = None,
+         exclude: [TokenCategory] = None,
          from_measure: int = None,
          to_measure: int = None,
-         tokenizer: Encoding = None,
-         instruments: [] = None,
+         encoding: Encoding = None,
+         instruments: [str] = None,
          show_measure_numbers: bool = None,
          spine_ids: [int] = None
          ) -> None:
@@ -104,7 +106,7 @@ def dump(document: Document, fp: Union[str, Path], *,
         exclude (Iterable): The token categories to exclude from the exported file. When None, no token categories will be excluded.
         from_measure (int): The measure to start exporting. When None, the exporter will start from the beginning of the file. The first measure is 1
         to_measure (int): The measure to end exporting. When None, the exporter will end at the end of the file.
-        tokenizer (Encoding): The type of the **kern file to export.
+        encoding (Encoding): The type of the **kern file to export.
         instruments (Iterable): The instruments to export. If None, all the instruments will be exported.
         show_measure_numbers (Bool): Show the measure numbers in the exported file.
         spine_ids (Iterable): The ids of the spines to export. When None, all the spines will be exported. \
@@ -130,7 +132,7 @@ def dump(document: Document, fp: Union[str, Path], *,
         exclude=exclude,
         from_measure=from_measure,
         to_measure=to_measure,
-        kern_type=tokenizer,
+        kern_type=encoding,
         instruments=instruments,
         show_measure_numbers=show_measure_numbers,
         spine_ids=spine_ids
@@ -144,13 +146,13 @@ def dump(document: Document, fp: Union[str, Path], *,
 
 
 def dumps(document: Document, *,
-          spine_types: [] = None,
-          include: [] = None,
-          exclude: [] = None,
+          spine_types: [str] = None,
+          include: [TokenCategory] = None,
+          exclude: [TokenCategory] = None,
           from_measure: int = None,
           to_measure: int = None,
-          tokenizer: Encoding = None,
-          instruments: [] = None,
+          encoding: Encoding = None,
+          instruments: [str] = None,
           show_measure_numbers: bool = None,
           spine_ids: [int] = None
           ) -> str:
@@ -164,7 +166,7 @@ def dumps(document: Document, *,
         exclude (Iterable): The token categories to exclude from the exported file. When None, no token categories will be excluded.
         from_measure (int): The measure to start exporting. When None, the exporter will start from the beginning of the file. The first measure is 1
         to_measure (int): The measure to end exporting. When None, the exporter will end at the end of the file.
-        tokenizer (Encoding): The type of the **kern file to export.
+        encoding (Encoding): The type of the **kern file to export.
         instruments (Iterable): The instruments to export. If None, all the instruments will be exported.
         show_measure_numbers (Bool): Show the measure numbers in the exported file.
         spine_ids (Iterable): The ids of the spines to export. When None, all the spines will be exported. \
@@ -189,7 +191,7 @@ def dumps(document: Document, *,
         exclude=exclude,
         from_measure=from_measure,
         to_measure=to_measure,
-        kern_type=tokenizer,
+        kern_type=encoding,
         instruments=instruments,
         show_measure_numbers=show_measure_numbers,
         spine_ids=spine_ids

{kernpy-1.0.1.dist-info → kernpy-1.0.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kernpy
-Version: 1.0.1
+Version: 1.0.2
 Summary: Python Humdrum **kern and **mens utilities
 Project-URL: Homepage, https://github.com/OMR-PRAIG-UA-ES/kernpy
 Project-URL: Documentation, https://github.com/OMR-PRAIG-UA-ES/kernpy#readme
@@ -174,32 +174,32 @@ kp.dump(document, "newfile_custom.krn",
 print(kp.BEKERN_CATEGORIES)
 ```
 
-- Use `tokenizer` to select how the categories are split. By default, the `normalizedKern` tokenizer is used.
+- Use `encoding` to select how the categories are split. By default, the `normalizedKern` encoding is used.
 
 ```python
 import kernpy as kp
 
 kp.dump(document, "newfile_normalized.krn",
-        tokenizer=kp.Encoding.normalizedKern)  # Default tokenizer
+        encoding=kp.Encoding.normalizedKern)  # Default encoding
 ```
-Select the proper Humdrum **kern tokenizer:
+Select the proper Humdrum **kern encoding:
 
-`kernpy` provides different tokenizers to export the content each symbol in different formats.
+`kernpy` provides different encodings to export the content each symbol in different formats.
 
-| Encoding | Tokenized    | Description                            |
+| Encoding | Output       | Description                            |
 |----------|--------------|----------------------------------------|
 | kern     | 2.bb-_L      | Traditional Humdrum **kern encoding    |
 | ekern    | 2@.@bb@-·_·L | Extended Humdrum **kern encoding       |
 
-Use the `Encoding` enum class to select the tokenizer:
+Use the `Encoding` enum class to select the encoding:
 
 ```python
 import kernpy as kp
 
 doc, _ = kp.load('resource_dir/legacy/chor048.krn')
 
-kern_content = kp.dumps(doc, tokenizer=kp.Encoding.normalizedKern)
-ekern_content = kp.dumps(doc, tokenizer=kp.Encoding.eKern)
+kern_content = kp.dumps(doc, encoding=kp.Encoding.normalizedKern)
+ekern_content = kp.dumps(doc, encoding=kp.Encoding.eKern)
 ```
 
 - Use `from_measure` and `to_measure` to select the measures to export. By default, all the measures are exported.
@@ -236,7 +236,7 @@ kp.dump(document, "newfile.krn",
         spine_types=['**kern'],  # Export only the **kern spines
         include=kp.BEKERN_CATEGORIES,  # Token categories to include
         exclude={kp.TokenCategory.PITCH},  # Token categories to exclude
-        tokenizer=kp.Encoding.eKern,  # Kern encoding
+        encoding=kp.Encoding.eKern,  # Kern encoding
         from_measure=1,  # First from measure 1
         to_measure=10,  # Last measure exported
         spine_ids=[0, 1],  # Export only the first and the second spine
@@ -339,7 +339,7 @@ for page_label, bounding_box_measure in doc.page_bounding_boxes.items():
    kp.dump(doc, f"foo_{page_label}.ekrn",
            spine_types=['**kern'],
            token_categories=kp.BEKERN_CATEGORIES,
-           tokenizer=kp.Encoding.eKern,
+           encoding=kp.Encoding.eKern,
            from_measure=bounding_box_measure.from_measure,
            to_measure=bounding_box_measure.to_measure - 1  # TODO: Check bounds            
            )

{kernpy-1.0.1.dist-info → kernpy-1.0.2.dist-info}/RECORD

@@ -11,7 +11,7 @@ kernpy/core/document.py,sha256=Y_Wpwc-t1GkaGr2QVU0hqLRFJv9wJ_Nm6UitgwAlT8w,34892
 kernpy/core/dyn_importer.py,sha256=dKgZqVIdEELUu8HY63ClLJAMQXXItjHmaYxxOwFZRiY,1025
 kernpy/core/dynam_spine_importer.py,sha256=crg4LwsWr56VZ6GLYAO1CDnLuum9f1tlX_pXCqKemEc,1450
 kernpy/core/error_listener.py,sha256=bTlAZvVIQx_6BLZ3oRut_pn24JnV8_7GnNONiwoMMPU,1516
-kernpy/core/exporter.py,sha256=5MWOk1JmPtpXfjN_VBv5jxUhYu8hhAZwt9eB5u9f1eM,21371
+kernpy/core/exporter.py,sha256=t2Ep-qe_r1CvEmPb3KoMpzHd2W3SfEcjY8XhFOUqGxs,21369
 kernpy/core/fing_spine_importer.py,sha256=5GLPPakmZVRcNbbaoCn1p1cQdat5QttflbpKu3AytQU,1382
 kernpy/core/generic.py,sha256=9OTDE2t49laVk6fgtydK5yZh7SCfZwViP_dZUJlskA8,10967
 kernpy/core/gkern.py,sha256=nRYFLFJ0uOLJwio0DKxQ0YIqLixy6-qCM-eY8DNdxfM,16332
@@ -27,7 +27,7 @@ kernpy/core/pitch_models.py,sha256=TpSt1uxGYhbhXs0viB1dNo4jiGxyCOHWseyRHTpfH-0,9
 kernpy/core/root_spine_importer.py,sha256=w7oFbMeXakHF9OAlgKWm_HaGJoNq6u7BE_JUnvLiLnU,1893
 kernpy/core/spine_importer.py,sha256=_VoWcVGfDMhxDn-hCu18g_29Aw2c2bjLnaXuvW2Fbsc,1430
 kernpy/core/text_spine_importer.py,sha256=mz1qX2nviJs0VsGsN87jk6BVWCIE7mmB9IxEx4RdhT8,1522
-kernpy/core/tokenizers.py,sha256=dJsaCdPStruzToaYA-RyM9beJ9tQyZRjM4qKLK0d0k4,7899
+kernpy/core/tokenizers.py,sha256=-m-isPSvWbikTLj5pfzG-4UCLrjxPfqHJD7s4znLHCo,7898
 kernpy/core/tokens.py,sha256=0XhbYm6F9NDfYpP5gbrgzZL3qB_xWs74faTwAZghpyM,66515
 kernpy/core/transposer.py,sha256=EqsEy7Z3bWIXdxUTruBrg8z9sWdJ3Cd_KIzo_6ZuNNA,9352
 kernpy/core/generated/kernSpineLexer.interp,sha256=Y3_seqmHQu3czO9fHE8XtRwTrk8g4Txf0IKiMaHBqeg,28801
@@ -39,13 +39,13 @@ kernpy/core/generated/kernSpineParser.tokens,sha256=ciGB91o4t7VM-tgSLtGB-BUFzHNo
 kernpy/core/generated/kernSpineParserListener.py,sha256=fcOPxYkGbNbIw8Qk9aqYXnuTB48WWJCn_ZYxTdoFtpY,40015
 kernpy/core/generated/kernSpineParserVisitor.py,sha256=YSEdcb4kuIi-E4rAFhDKsCVu0lyPdlqrCMtQAeVDhZY,23821
 kernpy/io/__init__.py,sha256=9103cE_Ao1tu2mi4EaFni-YmnCnwtJqQqFqgeFuT7rA,147
-kernpy/io/public.py,sha256=p5f22Vse54vU3QYDBn5Z5iJXhRLrF9OTG1MYD8QhdGc,13782
+kernpy/io/public.py,sha256=ge7A2N77efVG5dMpLDH2jxtkVi_2EOq-TnhDggyg9vQ,13861
 kernpy/polish_scores/__init__.py,sha256=EjILt5N5T9cKKdhWwflS_MU4TXuLhdHOYhW8txaicrI,217
 kernpy/polish_scores/download_polish_dataset.py,sha256=VqACpxDiM1yQYDs4QHHlZ87ZW2gkjl6R_bxYh5E67K4,14633
 kernpy/polish_scores/iiif.py,sha256=yITdrQbMsGmm8qag8TSousjCjS2io148Jk9xwEKa3B4,1526
 kernpy/util/__init__.py,sha256=dfW3nRSMkGQS7p7YebM271_0H8_pVw4IiDKeINs_LI8,152
 kernpy/util/helpers.py,sha256=Xbj3nWNyErdOpLHYd4uVyfwleXvmC5_FlYEhxaeTtS8,1549
 kernpy/util/store_cache.py,sha256=AA7SFCGQ6ryy-c02wbLy8gIQ2C-VdM1JSWFoWIK_KLA,1186
-kernpy-1.0.1.dist-info/METADATA,sha256=1SpNbdsg1KHO4FnR7vSeabwlsueGoA8y-4RDN-v2vZk,15096
-kernpy-1.0.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-kernpy-1.0.1.dist-info/RECORD,,
+kernpy-1.0.2.dist-info/METADATA,sha256=Uj7S-i6JIAMSEA4eyc-PTACGQX-hch51Ze2fnOJH1C4,15085
+kernpy-1.0.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+kernpy-1.0.2.dist-info/RECORD,,