setting up CI

.github/workflows/test.yml

@@ -1,24 +1,19 @@
 # This workflow will install Python dependencies, run tests and lint with a single version of Python
 # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
 
-name: Python application
-
+name: Build and test
 on:
   push:
     branches: [ "main", "dev-json" ]
   pull_request:
     branches: [ "main" ]
   merge_group:
-
-permissions:
-  contents: read
-
 jobs:
   build:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
     steps:
       - uses: actions/checkout@v4
       - name: Setup Python
@@ -28,8 +23,11 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
+          pip install --upgrade importlib-metadata
           pip install pytest
-          python -m install
+      - name: install xDEVS
+        run: |
+            python -m pip install .
       - name: Test with pytest
         run: |
           pytest

CHANGELOG.md

@@ -0,0 +1,26 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+
+### Added
+
+- Add real-time simulation capabilities, including input and output handlers
+- CI/CD pipeline for automated testing
+
+### Changed
+
+- Transitioned from setup.py to pyproject.toml for package configuration
+- Updated dependencies to latest versions
+- deltcon now does not accept any input arguments
+- All abstract classes are now defined in the `abc` module
+- All plugin factories are now defined in the `factory` module
+- Minimum Python version is now 3.9
+
+### Removed
+
+- Faulty parallel simulator

README.md

@@ -1,2 +1,3 @@
-# xdevs.py
+# `xdevs.py`
+
 Version of the xDEVS simulator for Python projects

pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "xdevs"
 version = "3.0.0"
-requires-python = ">=3.8"
+requires-python = ">=3.9"
 authors = [
   {name = "Román Cárdenas"},
   {name = "Óscar Fernández Sebastián"},

xdevs/__init__.py

@@ -1,3 +1,4 @@
+from __future__ import annotations
 import functools
 import logging
 import math

xdevs/factory.py

@@ -1,14 +1,22 @@
 from __future__ import annotations
 import json
-from importlib.metadata import entry_points
+import sys
+from importlib.metadata import entry_points, EntryPoint
 from typing import ClassVar
 from xdevs.abc import InputHandler, OutputHandler, Transducer
 from xdevs.models import Atomic, Component, Port, Coupled
 
 
+def load_entry_points(group: str) -> list[EntryPoint]:
+    if sys.version_info < (3, 10):
+        return entry_points().get(group, [])
+    else:
+        return entry_points(group=group)
+
+
 class InputHandlers:
     _plugins: ClassVar[dict[str, type[InputHandler]]] = {
-        ep.name: ep.load() for ep in entry_points(group='xdevs.input_handlers')
+        ep.name: ep.load() for ep in load_entry_points('xdevs.input_handlers')
     }
 
     @staticmethod
@@ -40,7 +48,7 @@ def create_input_handler(name: str, *args, **kwargs) -> InputHandler:
 
 class OutputHandlers:
     _plugins: ClassVar[dict[str, type[OutputHandler]]] = {
-        ep.name: ep.load() for ep in entry_points(group='xdevs.output_handlers')
+        ep.name: ep.load() for ep in load_entry_points('xdevs.output_handlers')
     }
 
     @staticmethod
@@ -73,7 +81,7 @@ def create_output_handler(name: str, *args, **kwargs) -> OutputHandler:
 
 class Wrappers:
     _plugins: ClassVar[dict[str, type[Atomic]]] = {
-        ep.name: ep.load() for ep in entry_points(group='xdevs.wrappers')
+        ep.name: ep.load() for ep in load_entry_points('xdevs.wrappers')
     }
 
     @staticmethod
@@ -91,7 +99,7 @@ def create_wrapper(name: str, *args, **kwargs) -> Atomic:
 
 class Transducers:
     _plugins: ClassVar[dict[str, type[Transducer]]] = {
-        ep.name: ep.load() for ep in entry_points(group='xdevs.transducers')
+        ep.name: ep.load() for ep in load_entry_points('xdevs.transducers')
     }
 
     @staticmethod
@@ -110,7 +118,7 @@ def create_transducer(name: str, *args, **kwargs) -> Transducer:
 class Components:
     """This class creates components from unique identifiers called "component_id"."""
     _plugins: ClassVar[dict[str, type[Component]]] = {
-        ep.name: ep.load() for ep in entry_points(group='xdevs.components')
+        ep.name: ep.load() for ep in load_entry_points('xdevs.components')
     }
 
     @staticmethod

xdevs/models.py

@@ -29,7 +29,8 @@ def __len__(self) -> int:
         return sum((len(port) for port in self._bag), len(self._values))
 
     def __str__(self) -> str:
-        return f'{self.name}<{self.p_type.__name__ if self.p_type is not None else 'None'}>'
+        p_type = self.p_type.__name__ if self.p_type is not None else 'None'
+        return f'{self.name}<{p_type}>'
 
     def __repr__(self) -> str:
         return str(self)

xdevs/plugins/input_handlers/bad_dependencies.py

@@ -1,3 +1,4 @@
+from __future__ import annotations
 from abc import ABC
 from xdevs.abc.handler import InputHandler
 
@@ -9,7 +10,8 @@ def __init__(self, **kwargs):
         :param str handler_type: transducer type.
         """
         super().__init__(**kwargs)
-        raise ImportError(f'{kwargs.get('handler_type')} input handler specific dependencies are not imported')
+        handler_type = kwargs['handler_type']
+        raise ImportError(f'{handler_type} input handler specific dependencies are not imported')
 
     def run(self):
         pass

xdevs/plugins/input_handlers/csv.py

@@ -1,3 +1,4 @@
+from __future__ import annotations
 import csv
 import sys
 import time

xdevs/plugins/input_handlers/function.py

@@ -1,3 +1,4 @@
+from __future__ import annotations
 from xdevs.abc.handler import InputHandler
 
 

xdevs/plugins/input_handlers/mqtt.py

@@ -1,3 +1,4 @@
+from __future__ import annotations
 import queue
 import threading
 

xdevs/plugins/output_handlers/bad_dependencies.py

@@ -1,3 +1,4 @@
+from __future__ import annotations
 from abc import ABC
 from xdevs.abc.handler import OutputHandler
 
@@ -9,7 +10,8 @@ def __init__(self, **kwargs):
         :param str handler_type: transducer type.
         """
         super().__init__(**kwargs)
-        raise ImportError(f'{kwargs['handler_type']} input handler specific dependencies are not imported')
+        handler_type = kwargs['handler_type']
+        raise ImportError(f'{handler_type} input handler specific dependencies are not imported')
 
     def run(self):
         pass

xdevs/plugins/output_handlers/csv.py

@@ -1,3 +1,4 @@
+from __future__ import annotations
 import csv
 import time
 from xdevs.abc.handler import OutputHandler

xdevs/plugins/output_handlers/mqtt.py

@@ -1,3 +1,4 @@
+from __future__ import annotations
 from typing import Callable, Any
 
 try:

xdevs/plugins/output_handlers/tcp.py

@@ -1,3 +1,4 @@
+from __future__ import annotations
 import time
 from typing import Any, Callable
 

xdevs/plugins/transducers/bad_dependencies.py

@@ -1,3 +1,4 @@
+from __future__ import annotations
 from abc import ABC
 from xdevs.abc.transducer import Transducer
 
@@ -9,7 +10,8 @@ def __init__(self, **kwargs):
         :param str transducer_type: transducer type.
         """
         super().__init__(**kwargs)
-        raise ImportError(f'{kwargs.get('transducer_type')} transducer specific dependencies are not imported')
+        transducer_type = kwargs['transducer_type']
+        raise ImportError(f'{transducer_type} transducer specific dependencies are not imported')
 
     def create_known_data_types_map(self):
         pass

xdevs/plugins/wrappers/bad_dependencies.py

@@ -1,3 +1,4 @@
+from __future__ import annotations
 from abc import ABC
 from xdevs.models import Atomic
 
@@ -9,7 +10,8 @@ def __init__(self, **kwargs):
         :param str wrapper_type: wrapper type.
         """
         super().__init__(**kwargs)
-        raise ImportError(f'{kwargs['wrapper_type']} wrapper specific dependencies are not installed')
+        wrapper_type = kwargs['wrapper_type']
+        raise ImportError(f'{wrapper_type} wrapper specific dependencies are not installed')
 
     def deltint(self):
         pass

xdevs/plugins/wrappers/pypdevs.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 try:
     from pypdevs.DEVS import AtomicDEVS
     from pypdevs.minimal import AtomicDEVS as AtomicDEVSMin

xdevs/sim.py

@@ -4,7 +4,6 @@
 import itertools
 import pickle
 import logging
-import warnings
 
 from abc import ABC, abstractmethod
 from collections import defaultdict