reuse __NAMESPACE__ variable, no longer expose ncml_2_2.py in API, docstring fixes

Author: Zeitsperre

src/xncml/generated/__init__.py

@@ -1,4 +1,4 @@
-from .ncml_2_2 import (
+from ._ncml_2_2 import (
     Aggregation,
     AggregationType,
     Attribute,

src/xncml/generated/ncml_2_2.py src/xncml/generated/_ncml_2_2.pysrc/xncml/generated/ncml_2_2.py renamed to src/xncml/generated/_ncml_2_2.py

@@ -49,7 +49,7 @@ class ObjectType(Enum):
 class CacheVariable:
     class Meta:
         name = "cacheVariable"
-        namespace = "http://www.unidata.ucar.edu/namespaces/netcdf/ncml-2.2"
+        namespace = __NAMESPACE__
 
     name: str | None = field(
         default=None,
@@ -64,7 +64,7 @@ class Meta:
 class Dimension:
     class Meta:
         name = "dimension"
-        namespace = "http://www.unidata.ucar.edu/namespaces/netcdf/ncml-2.2"
+        namespace = __NAMESPACE__
 
     name: str | None = field(
         default=None,
@@ -113,7 +113,7 @@ class Meta:
 class LogicalReduce:
     class Meta:
         name = "logicalReduce"
-        namespace = "http://www.unidata.ucar.edu/namespaces/netcdf/ncml-2.2"
+        namespace = __NAMESPACE__
 
     dim_names: str | None = field(
         default=None,
@@ -129,7 +129,7 @@ class Meta:
 class LogicalSection:
     class Meta:
         name = "logicalSection"
-        namespace = "http://www.unidata.ucar.edu/namespaces/netcdf/ncml-2.2"
+        namespace = __NAMESPACE__
 
     section: str | None = field(
         default=None,
@@ -144,7 +144,7 @@ class Meta:
 class LogicalSlice:
     class Meta:
         name = "logicalSlice"
-        namespace = "http://www.unidata.ucar.edu/namespaces/netcdf/ncml-2.2"
+        namespace = __NAMESPACE__
 
     dim_name: str | None = field(
         default=None,
@@ -167,7 +167,7 @@ class Meta:
 class PromoteGlobalAttribute:
     class Meta:
         name = "promoteGlobalAttribute"
-        namespace = "http://www.unidata.ucar.edu/namespaces/netcdf/ncml-2.2"
+        namespace = __NAMESPACE__
 
     name: str | None = field(
         default=None,
@@ -189,7 +189,7 @@ class Meta:
 class Values:
     class Meta:
         name = "values"
-        namespace = "http://www.unidata.ucar.edu/namespaces/netcdf/ncml-2.2"
+        namespace = __NAMESPACE__
 
     start: float | None = field(
         default=None,
@@ -236,7 +236,7 @@ class Meta:
 class Attribute:
     class Meta:
         name = "attribute"
-        namespace = "http://www.unidata.ucar.edu/namespaces/netcdf/ncml-2.2"
+        namespace = __NAMESPACE__
 
     name: str | None = field(
         default=None,
@@ -291,7 +291,7 @@ class Meta:
 class EnumTypedef:
     class Meta:
         name = "enumTypedef"
-        namespace = "http://www.unidata.ucar.edu/namespaces/netcdf/ncml-2.2"
+        namespace = __NAMESPACE__
 
     name: str | None = field(
         default=None,
@@ -344,7 +344,7 @@ class EnumType:
 class Remove:
     class Meta:
         name = "remove"
-        namespace = "http://www.unidata.ucar.edu/namespaces/netcdf/ncml-2.2"
+        namespace = __NAMESPACE__
 
     type: ObjectType | None = field(
         default=None,
@@ -366,7 +366,7 @@ class Meta:
 class Variable:
     class Meta:
         name = "variable"
-        namespace = "http://www.unidata.ucar.edu/namespaces/netcdf/ncml-2.2"
+        namespace = __NAMESPACE__
 
     attribute: list[Attribute] = field(
         default_factory=list,
@@ -451,7 +451,7 @@ class Meta:
 class Group:
     class Meta:
         name = "group"
-        namespace = "http://www.unidata.ucar.edu/namespaces/netcdf/ncml-2.2"
+        namespace = __NAMESPACE__
 
     choice: list[object] = field(
         default_factory=list,
@@ -505,7 +505,7 @@ class Meta:
 class Aggregation:
     class Meta:
         name = "aggregation"
-        namespace = "http://www.unidata.ucar.edu/namespaces/netcdf/ncml-2.2"
+        namespace = __NAMESPACE__
 
     choice: list[object] = field(
         default_factory=list,
@@ -732,7 +732,7 @@ class ScanFmrc:
 class Netcdf:
     class Meta:
         name = "netcdf"
-        namespace = "http://www.unidata.ucar.edu/namespaces/netcdf/ncml-2.2"
+        namespace = __NAMESPACE__
 
     read_metadata: object | None = field(
         default=None,

src/xncml/parser.py

@@ -300,7 +300,7 @@ def read_group(
       List of groups that must be read and included in `target`.
     parent_group_path : str
       Path of parent group, by default the root group '/'.
-    dims: dict[str, Dimension]
+    dims : dict[str, Dimension]
       Dictionary of the dimensions of this dataset.
 
     Returns
@@ -445,12 +445,12 @@ def read_enum(obj: EnumTypedef) -> dict[str, list]:
 
     Parameters
     ----------
-    obj: EnumTypeDef
+    obj : EnumTypeDef
       <enumTypeDef> object.
 
     Returns
     -------
-    dict:
+    dict
         A dictionary describing the Enum.
 
     Examples
@@ -486,9 +486,9 @@ def read_variable(
        <variable> object description.
     dimensions : dict
       Dimension attributes keyed by name.
-    enums: dict[str, dict]
+    enums : dict[str, dict]
       The enums types that have been read in the parent groups.
-    group_path: str
+    group_path : str
       Path to the parent group.
 
     Returns
@@ -590,7 +590,7 @@ def read_values(var_name: str, expected_size: int, values_tag: Values) -> list:
     ----------
     var_name : str
       The variable name.
-    size: int
+    size : int
       The variable expected size.
     values_tag : Values instance
       <values> object description
@@ -632,7 +632,7 @@ def build_scalar_variable(var_name: str, values_tag: Values, var_type: str) -> x
       The variable name.
     values_tag : Values instance
       <values> object description
-    var_type: str
+    var_type : str
       The variable expected type.
 
     Returns