Merge branch 'master' into master

Author: JuliaSprenger

.github/workflows/io-test.yml

@@ -1,27 +1,23 @@
 name: NeoIoTest
 
 on:
-  pull_request:
-    branches: [master]
-    types: [synchronize, opened, reopened, ready_for_review]
-
-  # run checks on any change of master, including merge of PRs
-  push:
-    branches: [master]
+  workflow_call:
+    inputs:
+      os:
+        required: true
+        type: string
 
 concurrency:  # Cancel previous workflows on the same pull request
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
 
 jobs:
   build-and-test:
-    name: Test on (${{ matrix.os }})
-    runs-on: ${{ matrix.os }}
+    name: Test on (${{ inputs.os }})
+    runs-on: ${{ inputs.os }}
     strategy:
       fail-fast: true
       matrix:
-        # "macos-latest", "windows-latest"
-        os: ["ubuntu-latest", ]
         python-version: ['3.9', ]
     defaults:
       # by default run in bash mode (required for conda usage)
@@ -50,7 +46,7 @@ jobs:
           key: ${{ runner.os }}-datasets-${{ steps.ephy_testing_data.outputs.dataset_hash }}
           restore-keys: ${{ runner.os }}-datasets-
 
-      - uses: conda-incubator/setup-miniconda@v2
+      - uses: conda-incubator/setup-miniconda@v2.2.0
         with:
           activate-environment: neo-test-env
           python-version: ${{ matrix.python-version }}
@@ -99,6 +95,13 @@ jobs:
         run: |
           pip install --no-dependencies -e .
 
+      - name: Install wine
+        run: |
+          sudo rm -f /etc/apt/sources.list.d/microsoft-prod.list
+          sudo dpkg --add-architecture i386
+          sudo apt-get update -qq
+          sudo apt-get install -yqq --allow-downgrades libc6:i386 libgcc-s1:i386 libstdc++6:i386 wine
+
       - name: Test with pytest
         run: |
           # only neo.rawio and neo.io

.github/workflows/io-test_dispatch.yml

@@ -0,0 +1,19 @@
+name: NeoIoTest-manual-trigger
+
+on:
+  workflow_dispatch:
+    inputs:
+      os:
+        description: 'The operating system to run the tests on'
+        required: True
+        default: 'ubuntu-latest'
+        type: choice
+        options:
+          - macos-latest
+          - windows-latest
+
+jobs:
+  call-iotests:
+    uses: ./.github/workflows/io-test.yml
+    with:
+      os: ${{ inputs.os }}

.github/workflows/io-test_trigger.yml

@@ -0,0 +1,16 @@
+name: NeoIoTest-automatic-trigger
+
+on:
+  pull_request:
+    branches: [master]
+    types: [synchronize, opened, reopened, ready_for_review]
+
+  # run checks on any change of master, including merge of PRs
+  push:
+    branches: [master]
+
+jobs:
+  call-iotests:
+    uses: ./.github/workflows/io-test.yml
+    with:
+      os: ubuntu-latest

doc/source/authors.rst

@@ -62,6 +62,7 @@ and may not be the current affiliation of a contributor.
 * Elodie Legouée [21]
 * Heberto Mayorquin [24]
 * Thomas Perret [25]
+* Kyle Johnsen [26, 27]
 
 1. Centre de Recherche en Neuroscience de Lyon, CNRS UMR5292 - INSERM U1028 - Universite Claude Bernard Lyon 1
 2. Unité de Neuroscience, Information et Complexité, CNRS UPR 3293, Gif-sur-Yvette, France
@@ -88,6 +89,8 @@ and may not be the current affiliation of a contributor.
 23. Bio Engineering Laboratory, DBSSE, ETH, Basel, Switzerland
 24. CatalystNeuro
 25. Institut des Sciences Cognitives Marc Jeannerod, CNRS UMR5229, Lyon, France
+26. Georgia Institute of Technology
+27. Emory University
 
 If we've somehow missed you off the list we're very sorry - please let us know.
 

neo/core/container.py

@@ -327,6 +327,39 @@ def size(self):
         return {name: len(getattr(self, name))
                     for name in self._child_containers}
 
+    @property
+    def _container_lookup(self):
+        return {
+            cls_name: getattr(self, container_name)
+            for cls_name, container_name in zip(self._child_objects, self._child_containers)
+        }
+
+    def _get_container(self, cls):
+        if hasattr(cls, "proxy_for"):
+            cls = cls.proxy_for
+        return self._container_lookup[cls.__name__]
+
+    def add(self, *objects):
+        """Add a new Neo object to the Container"""
+        for obj in objects:
+            if (
+                obj.__class__.__name__ in self._child_objects
+                or (
+                    hasattr(obj, "proxy_for")
+                    and obj.proxy_for.__name__ in self._child_objects
+                )
+            ):
+                container = self._get_container(obj.__class__)
+                container.append(obj)
+            else:
+                raise TypeError(
+                    f"Cannot add object of type {obj.__class__.__name__} "
+                    f"to a {self.__class__.__name__}, can only add objects of the "
+                    f"following types: {self._child_objects}"
+                )
+
+
+
     def filter(self, targdict=None, data=True, container=False, recursive=True,
                objects=None, **kwargs):
         """

neo/core/dataobject.py

@@ -20,7 +20,7 @@ def _normalize_array_annotations(value, length):
 
     Parameters
     ----------
-    value : np.ndarray or list or dict
+    value : np.ndarray or list or tuple or dict
         Value to be checked for consistency.
     length : int
         Required length of the array annotation.
@@ -48,7 +48,7 @@ def _normalize_array_annotations(value, length):
         raise ValueError("Array annotations must not be None")
     # If not array annotation, pass on to regular check and make it a list, that is checked again
     # This covers array annotations with length 1
-    elif not isinstance(value, (list, np.ndarray)) or (
+    elif not isinstance(value, (list, np.ndarray, tuple)) or (
             isinstance(value, pq.Quantity) and value.shape == ()):
         _check_annotations(value)
         value = _normalize_array_annotations(np.array([value]), length)

neo/core/group.py

@@ -76,6 +76,9 @@ def __init__(self, objects=None, name=None, description=None, file_origin=None,
             self.allowed_types = None
         else:
             self.allowed_types = tuple(allowed_types)
+            for type_ in self.allowed_types:
+                if type_.__name__ not in self._child_objects:
+                    raise TypeError(f"Groups can not contain objects of type {type_.__name__}")
 
         if objects:
             self.add(*objects)
@@ -134,26 +137,13 @@ def __init__(self, objects=None, name=None, description=None, file_origin=None,
         doc="list of Groups contained in this group"
     )
 
-    @property
-    def _container_lookup(self):
-        return {
-            cls_name: getattr(self, container_name)
-            for cls_name, container_name in zip(self._child_objects, self._child_containers)
-        }
-
-    def _get_container(self, cls):
-        if hasattr(cls, "proxy_for"):
-            cls = cls.proxy_for
-        return self._container_lookup[cls.__name__]
-
     def add(self, *objects):
         """Add a new Neo object to the Group"""
         for obj in objects:
             if self.allowed_types and not isinstance(obj, self.allowed_types):
                 raise TypeError("This Group can only contain {}, but not {}"
                                 "".format(self.allowed_types, type(obj)))
-            container = self._get_container(obj.__class__)
-            container.append(obj)
+        super().add(*objects)
 
     def walk(self):
         """

neo/io/__init__.py

@@ -54,6 +54,7 @@
 * :attr:`PhyIO`
 * :attr:`PickleIO`
 * :attr:`PlexonIO`
+* :attr:`Plexon2IO`
 * :attr:`RawBinarySignalIO`
 * :attr:`RawMCSIO`
 * :attr:`Spike2IO`
@@ -226,6 +227,10 @@
 
     .. autoattribute:: extensions
 
+.. autoclass:: neo.io.Plexon2IO
+
+    .. autoattribute:: extensions
+
 .. autoclass:: neo.io.RawBinarySignalIO
 
     .. autoattribute:: extensions
@@ -328,6 +333,7 @@
 from neo.io.phyio import PhyIO
 from neo.io.pickleio import PickleIO
 from neo.io.plexonio import PlexonIO
+from neo.io.plexon2io import Plexon2IO
 from neo.io.rawbinarysignalio import RawBinarySignalIO
 from neo.io.rawmcsio import RawMCSIO
 from neo.io.spike2io import Spike2IO
@@ -382,6 +388,7 @@
     PhyIO,
     PickleIO,
     PlexonIO,
+    Plexon2IO,
     RawBinarySignalIO,
     RawMCSIO,
     Spike2IO,
@@ -458,8 +465,23 @@ def list_candidate_ios(file_or_folder, ignore_patterns=['*.ini', 'README.txt', '
     # if only file prefix was provided, e.g /mydatafolder/session1-
     # to select all files sharing the `session1-` prefix
     elif file_or_folder.parent.exists():
-        filenames = file_or_folder.parent.glob(file_or_folder.name + '*')
-
+        filenames = list(file_or_folder.parent.glob(file_or_folder.name + '*'))
+        # if filenames empty and suffix is provided then non-existent file
+        # may be written in current dir. So run check for io
+        if len(filenames)==0 and file_or_folder.suffix:
+            suffix = file_or_folder.suffix[1:].lower()
+            if suffix not in io_by_extension:
+                raise ValueError(f'{suffix} is not a supported format of any IO.')
+            return io_by_extension[suffix]
+
+    # If non-existent file in non-existent dir is given check if this 
+    # structure could be created with an io writing the file
+    elif file_or_folder.suffix:
+        suffix = file_or_folder.suffix[1:].lower()
+        if suffix not in io_by_extension:
+            raise ValueError(f'{suffix} is not a supported format of any IO.')
+        return io_by_extension[suffix]
+    
     else:
         raise ValueError(f'{file_or_folder} does not contain data files of a supported format')
 

neo/io/plexon2io.py

@@ -0,0 +1,17 @@
+from neo.io.basefromrawio import BaseFromRaw
+from neo.rawio.plexon2rawio import Plexon2RawIO
+
+
+class Plexon2IO(Plexon2RawIO, BaseFromRaw):
+    """
+    Class for reading data from Plexon PL2 files
+
+    The IO is based on the Plexon2RawIO, see comments for memory optimization
+    in neo.rawio.plexon2rawio.Plexon2RawIO
+
+    """
+
+    def __init__(self, filename):
+        Plexon2RawIO.__init__(self, filename=filename)
+        BaseFromRaw.__init__(self, filename)
+

neo/io/plexonio.py

@@ -16,5 +16,5 @@ class PlexonIO(PlexonRawIO, BaseFromRaw):
     _prefered_signal_group_mode = 'group-by-same-units'
 
     def __init__(self, filename):
-        PlexonRawIO.__init__(self, filename=filename)
+        PlexonRawIO.__init__(self, filename)
         BaseFromRaw.__init__(self, filename)