Merge pull request #211 from nucleic/fixed-tuple

Add FixedTuple member enforcing a given number of items

Author: MatthieuDartiailh

.coveragerc

@@ -105,8 +105,6 @@ jobs:
         uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
-          cache: 'pip'
-          cache-dependency-path: 'test_requirements.txt'
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
@@ -119,11 +117,9 @@ jobs:
         run: |
           pip install -e .
       - name: Test with pytest
-        # XXX Disabled warnings check ( -W error) to be able to test on 3.11
-        # (pyparsing deprecation)
         run: |
           pip install -r test_requirements.txt
-          python -X dev -m pytest tests --ignore=tests/type_checking --cov --cov-report xml -v
+          python -X dev -m pytest tests --ignore=tests/type_checking --cov --cov-report xml -v -W error
       - name: Generate C++ coverage reports
         if: (github.event_name != 'schedule' && matrix.os != 'windows-latest')
         run: |

.flake8

@@ -5,9 +5,8 @@
 #
 # The full license is in the file LICENSE, distributed with this software.
 # --------------------------------------------------------------------------------------
-"""Module exporting the public interface to atom.
+"""Module exporting the public interface to atom."""
 
-"""
 from .atom import Atom
 from .catom import (
     CAtom,
@@ -61,7 +60,7 @@
 from .set import Set
 from .signal import Signal
 from .subclass import ForwardSubclass, Subclass
-from .tuple import Tuple
+from .tuple import FixedTuple, Tuple
 from .typed import ForwardTyped, Typed
 from .typing_utils import ChangeDict
 
@@ -120,5 +119,6 @@
     "Tuple",
     "ForwardTyped",
     "Typed",
+    "FixedTuple",
     "ChangeDict",
 ]

.github/workflows/ci.yml

@@ -537,6 +537,7 @@ class Validate(IntEnum):
     Dict = ...
     DefaultDict = ...
     Enum = ...
+    FixedTuple = ...
     Float = ...
     FloatPromote = ...
     FloatRange = ...

atom/api.py

@@ -6,6 +6,7 @@
 # The full license is in the file LICENSE, distributed with this software.
 # --------------------------------------------------------------------------------------
 """Atom metaclass and tools used to create atom subclasses."""
+
 from .atom_meta import AtomMeta, MissingMemberWarning, add_member, clone_if_needed
 from .member_modifiers import set_default
 from .observation import observe

atom/catom.pyi

@@ -16,7 +16,7 @@
 from ..scalars import Bool, Bytes, Callable as ACallable, Float, Int, Str, Value
 from ..set import Set as ASet
 from ..subclass import Subclass
-from ..tuple import Tuple as ATuple
+from ..tuple import FixedTuple, Tuple as ATuple
 from ..typed import Typed
 from ..typing_utils import extract_types, get_args, is_optional
 from .member_modifiers import set_default
@@ -71,10 +71,10 @@ def generate_member_from_type_or_generic(
         ):
             # We can only validate homogeneous tuple so far so we ignore other cases
             if t is tuple:
-                if (...) in parameters or len(set(parameters)) == 1:
+                if (...) in parameters:
                     parameters = (parameters[0],)
                 else:
-                    parameters = ()
+                    m_cls = FixedTuple
             parameters = tuple(
                 generate_member_from_type_or_generic(
                     t, _NO_DEFAULT, annotate_type_containers - 1

atom/meta/__init__.py

@@ -6,6 +6,7 @@
 # The full license is in the file LICENSE, distributed with this software.
 # --------------------------------------------------------------------------------------
 """Metaclass implementing atom members customization."""
+
 import copyreg
 import warnings
 from types import FunctionType

atom/meta/annotation_utils.py

@@ -6,6 +6,7 @@
 # The full license is in the file LICENSE, distributed with this software.
 # --------------------------------------------------------------------------------------
 """Custom marker objects used to modify the default settings of a member."""
+
 from typing import Any, Optional
 
 
@@ -28,3 +29,9 @@ def __init__(self, value: Any) -> None:
     def clone(self) -> "set_default":
         """Create a clone of the sentinel."""
         return type(self)(self.value)
+
+
+# XXX add more sentinels here to allow customizing members without using the
+# members themselves:
+# - tag
+#

atom/meta/atom_meta.py

@@ -6,6 +6,7 @@
 # The full license is in the file LICENSE, distributed with this software.
 # --------------------------------------------------------------------------------------
 """Tools to declare static observers in Atom subclasses"""
+
 from types import FunctionType
 from typing import (
     TYPE_CHECKING,