Merge pull request #25 from xsuite/release/v0.3.2

Release 0.3.2

Author: freddieknets

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "xaux"
-version = "0.3.1"
+version = "0.3.2"
 description = "Support tools for Xsuite packages"
 authors = ["Frederik F. Van der Veken <[email protected]>",
            "Thomas Pugnat <[email protected]>",

tests/clean.sh

@@ -6,7 +6,7 @@ do
   fi
 done
 
-for f in example_file.txt test_*.json test_*.json.lock test_cronjob.txt
+for f in example_file.txt test_*.json test_*.json.lock test_cronjob.txt default_file_?.txt
 do
   if [ -e $f ]
   then

tests/test_version.py

@@ -6,5 +6,5 @@
 from xaux import __version__
 
 def test_version():
-    assert __version__ == '0.3.1'
+    assert __version__ == '0.3.2'
 

xaux/fs/eos.py

@@ -200,6 +200,11 @@ def mkdir(self, *args, **kwargs):
     def rmdir(self, *args, **kwargs):
         return _eos_rmdir(self.expanduser(), *args, **kwargs)
 
+    def as_posix(self, *args, **kwargs):
+        if hasattr(self, 'eos_path'):
+            return self.eos_path
+        return Path.as_posix(self, *args, **kwargs)
+
     # def glob(self, *args, **kwargs):
     #     raise NotImplementedError
 
@@ -220,9 +225,6 @@ def rmtree(self, *args, **kwargs):
     def size(self, *args, **kwargs):
         return _eos_size(self.expanduser(), FsPath, *args, **kwargs)
 
-    def as_posix(self, *args, **kwargs):
-        return self.eos_path
-
 
 class EosPosixPath(EosPath, PurePosixPath):
     """EosPath subclass for EOS paths on non-Windows systems.

xaux/general.py

@@ -10,5 +10,5 @@
 # ===================
 # Do not change
 # ===================
-__version__ = '0.3.1'
+__version__ = '0.3.2'
 # ===================

xaux/tools/singleton.py

@@ -24,15 +24,20 @@ def __repr__(self):
         """This a default __repr__ method for the singleton."""
     def __getattribute__(self, name):
         """The __getattribute__ method is expanded to implement the singleton."""
+    def delete(cls):
+        """The delete() method removes the singleton and invalidates any existing instances,
+        allowing to create a new instance the next time the class is instantiated. This is
+        useful for resetting the singleton to its default values.
+        """
     def get_self(cls, **kwargs):
         """The get_self(**kwargs) method returns the singleton instance, allowing to pass
         any kwargs to the constructor, even if they are not attributes of the singleton.
         This is useful for kwargs filtering in getters or specific functions.
         """
-    def delete(cls):
-        """The delete() method removes the singleton and invalidates any existing instances,
-        allowing to create a new instance the next time the class is instantiated. This is
-        useful for resetting the singleton to its default values.
+    def filter_kwargs(cls, **kwargs):
+        """The filter_kwargs(**kwargs) method splits the kwargs into non-class kwargs and
+        class kwargs. This is useful after a call to `get_self(**kwargs)` to only keep the
+        kwargs that are not attributes of the singleton.
         """
 
 
@@ -191,21 +196,34 @@ def delete(this_cls):
             @classmethod
             @functools.wraps(Singleton.get_self)
             def get_self(this_cls, **kwargs):
+                _, filtered_kwargs = this_cls.filter_kwargs(**kwargs)
+                if '_singleton_instance' not in this_cls.__dict__:
+                    self = this_cls()
+                else:
+                    self = this_cls._singleton_instance
+                for kk, vv in filtered_kwargs.items():
+                    setattr(self, kk, vv)
+                return self
+
+            @classmethod
+            @functools.wraps(Singleton.filter_kwargs)
+            def filter_kwargs(this_cls, **kwargs):
                 # Need to initialise in case the instance does not yet exist
                 # (to recognise the allowed fields)
                 if '_singleton_instance' not in this_cls.__dict__:
                     self = this_cls()
                 else:
                     self = this_cls._singleton_instance
-                filtered_kwargs = {key: value for key, value in kwargs.items()
+                cls_kwargs = {key: value for key, value in kwargs.items()
                                 if hasattr(this_cls, key) \
                                 or hasattr(this_cls._singleton_instance, key)}
                 if not allow_underscore_vars_in_init:
-                    filtered_kwargs = {key: value for key, value in filtered_kwargs.items()
+                    cls_kwargs = {key: value for key, value in cls_kwargs.items()
                                     if not key.startswith('_')}
-                for kk, vv in filtered_kwargs.items():
-                    setattr(self, kk, vv)
-                return self
+                non_cls_kwargs = kwargs.copy()
+                for kk in cls_kwargs.keys():
+                    non_cls_kwargs.pop(kk)
+                return non_cls_kwargs, cls_kwargs
 
         # Rename the original class, for clarity in the __mro__ etc
         cls.__name__ = f"{cls.__name__}Original"
@@ -253,4 +271,4 @@ def _get_cls_functions(cls):
                                  else Singleton.__init_subclass__
         wrap_getattribute = cls.__getattribute__ if cls.__dict__.get('__getattribute__') \
                                                is not None else Singleton.__getattribute__
-        return wrap_new, wrap_init, wrap_init_subclass, wrap_getattribute
+        return wrap_new, wrap_init, wrap_init_subclass, wrap_getattribute