Commit: 80e84a4d4dce9b2f1eb6f508be8882d341445552 - CCastle2 (hg)

Castle: The best Real-Time/Embedded/HighTech language EVER. Attempt 2

Commit MetaInfo

• Revision: 80e84a4d4dce9b2f1eb6f508be8882d341445552 (tree)
• Time: 2023-09-23 19:18:07
• Author: Albert Mietus < albert AT mietus DOT nl >
• Commiter: Albert Mietus < albert AT mietus DOT nl >

Log Message

More aigr groundwork

Change Summary

• modified: Makefile
• modified: castle/aigr/__init__.py
• modified: castle/aigr/events.py
• modified: castle/aigr/protocols.py
• add: castle/aigr/types.py
• add: pytst/aigr/test_1_events.py

Incremental Difference

diff -r 6a4855765d41 -r 80e84a4d4dce Makefile
--- a/Makefile	Sat Sep 23 11:54:36 2023 +0200
+++ b/Makefile	Sat Sep 23 12:18:07 2023 +0200
@@ -9,9 +9,10 @@
 # TODO:		Some test that are needed soon
 rPY_LAST = \
 	pytst/writers/RPy/test_0_templating.py			\
+	pytst/aigr/test_0_AIGR.py				\
 #
 rPY_CURRENT = \
-	pytst/aigr/test_0_AIGR.py				\
+	pytst/aigr/test_1_events.py				\
 #
 CC2CPy_TODO = \
 	pytst/writers/RPy/test_999.py 				\

diff -r 6a4855765d41 -r 80e84a4d4dce castle/aigr/__init__.py
--- a/castle/aigr/__init__.py	Sat Sep 23 11:54:36 2023 +0200
+++ b/castle/aigr/__init__.py	Sat Sep 23 12:18:07 2023 +0200
@@ -8,4 +8,5 @@
         return super().__new__(cls)
 
 
-
+from .events import *
+from .protocols import *

diff -r 6a4855765d41 -r 80e84a4d4dce castle/aigr/events.py
--- a/castle/aigr/events.py	Sat Sep 23 11:54:36 2023 +0200
+++ b/castle/aigr/events.py	Sat Sep 23 12:18:07 2023 +0200
@@ -6,23 +6,24 @@
   - better
 TODO: update the CC2Cpy parts to use this generic AIGR layer
 """
+
+import typing as PTH                                                    # Python TypeHints
 from dataclasses import dataclass, KW_ONLY
 from . import AIGR
-from .types import TypedParameter
+from .types import TypedParameter                                      # Castle/AIGR types
 
 __all__ = ['Event']
 
-from dataclasses import dataclass, KW_ONLY
 
-from castle.auxiliary import AIGR
 
-@dataclass                              # pragma: no mutate
+
+@dataclass                                                  # pragma: no mutate
 class Event(AIGR):
     """An event is like a (remote) function-call
 
-    It has a name, a return-type (can be void), and a sequence of typed parameters."""
+    It has a name, a return-type (can be void), and an (inmutable) sequence of typed parameters."""
 
     name: str
-    _: KW_ONLY # The field below must be passed as keywords, when initialising
+    _: KW_ONLY
     return_type: type=None
-    typedParameters: Sequence[TypedParameter]=()                                ## A tuple `()` is inmutable
+    typedParameters: PTH.Sequence[TypedParameter]=()

diff -r 6a4855765d41 -r 80e84a4d4dce castle/aigr/protocols.py
--- a/castle/aigr/protocols.py	Sat Sep 23 11:54:36 2023 +0200
+++ b/castle/aigr/protocols.py	Sat Sep 23 12:18:07 2023 +0200
@@ -7,8 +7,10 @@
 TODO: update the CC2Cpy parts to use this generic AIGR layer
 """
 
+import typing as PTH                                                    # Python TypeHints
 from enum import Enum
 from dataclasses import dataclass, KW_ONLY
+from dataclasses import field as dc_field
 from . import AIGR
 from .events import Event
 
@@ -27,18 +29,18 @@
     Stream   = 3
 
 
-Protocol: TypeAlias = 'Protocol'            # forward reference                                      # pragma: no mutate
+Protocol: PTH.TypeAlias = 'Protocol'            # forward reference                                      # pragma: no mutate
 @dataclass
 class Protocol(AIGR):
     """ .. note:: Use one of the subclasses -- Only Event is defined yet
         .. todo:: Design: What is the `kind` self and the inherited ones are not the same?
                   overriding ProtocolKind.Unknown is always allowed
     """
-    _BASE: ClassVar=None                                                                             # pragma: no mutate
+    _BASE: PTH.ClassVar=None                                                                             # pragma: no mutate
 
     name: str
     kind: ProtocolKind
-    based_on: Optional[Protocol]=dc_field(default_factory= lambda :Protocol._BASE)
+    based_on: PTH.Optional[Protocol]=dc_field(default_factory= lambda :Protocol._BASE)
 
 
 @dataclass
@@ -62,5 +64,5 @@
     """
     _: KW_ONLY
     kind: ProtocolKind = ProtocolKind.Event
-    events: Sequence[Event]
+    events: PTH.Sequence[Event]
 

diff -r 6a4855765d41 -r 80e84a4d4dce castle/aigr/types.py
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/castle/aigr/types.py	Sat Sep 23 12:18:07 2023 +0200
@@ -0,0 +1,24 @@
+# (C) Albert Mietus, 2023. Part of Castle/CCastle project
+
+""" This file is based (a fork) on `../writers/CC2Cpy/Protocol.py`,
+  - the rendering part is removed
+  - the prefixed are gone
+  - better
+TODO: update the CC2Cpy parts to use this generic AIGR layer
+"""
+
+import typing as PTH                                       # Python TypeHints
+from enum import Enum
+from dataclasses import dataclass, KW_ONLY
+from . import AIGR
+
+# XXX__all__ = [
+@dataclass
+class TypedParameter(AIGR):
+    """This is many a helper class/struct to combine a parameter: a name and an type"""
+    name: str
+    type: type
+
+
+TypedParameterTuple: PTH.TypeAlias = PTH.Sequence[TypedParameter]
+

diff -r 6a4855765d41 -r 80e84a4d4dce pytst/aigr/test_1_events.py
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/pytst/aigr/test_1_events.py	Sat Sep 23 12:18:07 2023 +0200
@@ -0,0 +1,22 @@
+# (C) Albert Mietus, 2022, 2023. Part of Castle/CCastle project
+
+
+from castle.aigr import Event
+from castle.aigr.types import TypedParameter
+
+def test_0_Event_empty():
+    e = Event("leeg_event")
+    assert e.name                 == 'leeg_event'
+    assert e.return_type          is None
+    assert len(e.typedParameters) == 0
+
+def test_1_Event_small():
+    e = Event("demo_int", typedParameters=[TypedParameter(name='p1', type=float )])
+    assert e.return_type             is None
+    assert len(e.typedParameters)    == 1
+    assert e.typedParameters[0].name == 'p1'
+    assert e.typedParameters[0].type == float
+
+def test_2_Event_retunInt():
+    e = Event("an_event", return_type=int)
+    assert e.return_type == int