Skip to content

Recorder

Bases: ABC

Source code in gamms/typing/recorder.py 
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
class IRecorder(ABC):
    @abstractmethod
    def record(self) -> bool:
        """
        Boolean to inform whether game is being recorded or not and ctx is alive

        Returns:
            bool: True if recording, False otherwise
        """
        pass

    @abstractmethod
    def start(self, path: Union[str, BinaryIO]) -> None:
        """
        Start recording to the path. Raise error if file already exists
        Adds ".ggr" extension if not present.

        If path is a file object, it will be used as the file handler.

        Args:
            path (Union[str, BinaryIO]): Path to record the game.

        Raises:
            FileExistsError: If the file already exists.
            TypeError: If the path is not a string or file object.
        """
        pass
    @abstractmethod
    def stop(self) -> None:
        """
        Stop recording to the path and close the file handler.

        Raises:
            RuntimeError: If recording has not started.
        """
        pass
    @abstractmethod
    def pause(self) -> None:
        """
        Pause the recording process. `self.record()` should return false if paused.  If not started or stopped, give warning.
        """
        pass
    @abstractmethod
    def play(self) -> None:
        """
        Resume recording if paused. If not started or stopped, give warning.
        """
        pass
    @abstractmethod    
    def replay(self, path: Union[str, BinaryIO]) -> Iterator[Dict[str, Any]]:
        """
        Checks validity of the file and output an iterator.

        Args:
            path (Union[str, BinaryIO]): Path to the recording file.

        Returns:
            Iterator: Iterator to replay the recording.

        Raises:
            RuntimeError: If replay is already in progress.
            FileNotFoundError: If the file does not exist.
            TypeError: If the path is not a string or file object.
            ValueError: If the file is not a valid recording file or if recording terminated unexpectedly.
            ValueError: If the version of the file is not supported.
        """
        pass
    @abstractmethod
    def time(self) -> int:
        """
        Return record time if replaying. Else return the local time `(time.time())` in nano seconds.

        Returns:
            int: Time in nanoseconds.
        """
        pass
    @abstractmethod
    def write(self, opCode: OpCodes, data: Dict[str, JsonType]) -> None:
        """
        Write to record buffer if recording. If not recording raise error as it should not happen.

        WARNING: This function should not be required to be called by the user in most cases.
        """
        pass

    @abstractmethod
    def component(self, struct: Dict[str, Type[_T]]) -> Callable[[Type[_T]], Type[_T]]:
        """
        Decorator to add a component to the recorder.

        Args:
            struct (Dict[str, Type[_T]]): Dictionary with component name and type.

        Returns:
            Callable[[Type[_T]], Type[_T]]: Decorator function.

        """
        pass

    @abstractmethod
    def get_component(self, name: str) -> object:
        """
        Get the component from the name.

        Args:
            name (str): Name of the component.

        Returns:
            Type[_T]: Component object.

        Raises:
            KeyError: If the component is not found.
        """
        pass

    @abstractmethod
    def delete_component(self, name: str) -> None:
        """
        Delete the component from the name.

        Args:
            name (str): Name of the component.

        Raises:
            KeyError: If the component is not found.

        """
        pass

    @abstractmethod
    def component_iter(self) -> Iterator[str]:
        """
        Iterator for the component names.
        """
        pass

    @abstractmethod
    def add_component(self, name: str, obj: Type[_T]) -> None:
        """
        Add a component to the recorder.

        Args:
            name (str): Name of the component.
            obj (Type[_T]): Component object.

        Raises:
            ValueError: If the component already exists.
        """
        pass

    @abstractmethod
    def is_component_registered(self, key: Tuple[str, str]) -> bool:
        """
        Check if the component is registered.
        Key is (module_name, qualname)

        Args:
            key (Tuple[str, str]): Key to check.

        Returns:
            bool: True if registered, False otherwise.
        """
        pass

    @abstractmethod
    def unregister_component(self, key: Tuple[str, str]) -> None:
        """
        Unregister the component.
        Key is (module_name, qualname)

        Args:
            key (Tuple[str, str]): Key to unregister.

        Raises:
            KeyError: If the component is not found.
        """
        pass

add_component(name, obj) abstractmethod

Add a component to the recorder.

Parameters:

Name Type Description Default
name str

Name of the component.

 required
obj Type[_T]

Component object.

 required

Raises:

Type Description
ValueError

If the component already exists.
Source code in gamms/typing/recorder.py 
145
146
147
148
149
150
151
152
153
154
155
156
157
@abstractmethod
def add_component(self, name: str, obj: Type[_T]) -> None:
    """
    Add a component to the recorder.

    Args:
        name (str): Name of the component.
        obj (Type[_T]): Component object.

    Raises:
        ValueError: If the component already exists.
    """
    pass

component(struct) abstractmethod

Decorator to add a component to the recorder.

Parameters:

Name Type Description Default
struct Dict[str, Type[_T]]

Dictionary with component name and type.

 required

Returns:

Type Description
Callable[[Type[_T]], Type[_T]]

Callable[[Type[_T]], Type[_T]]: Decorator function.
Source code in gamms/typing/recorder.py 
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
@abstractmethod
def component(self, struct: Dict[str, Type[_T]]) -> Callable[[Type[_T]], Type[_T]]:
    """
    Decorator to add a component to the recorder.

    Args:
        struct (Dict[str, Type[_T]]): Dictionary with component name and type.

    Returns:
        Callable[[Type[_T]], Type[_T]]: Decorator function.

    """
    pass

component_iter() abstractmethod

Iterator for the component names.

Source code in gamms/typing/recorder.py 
138
139
140
141
142
143
@abstractmethod
def component_iter(self) -> Iterator[str]:
    """
    Iterator for the component names.
    """
    pass

delete_component(name) abstractmethod

Delete the component from the name.

Parameters:

Name Type Description Default
name str

Name of the component.

 required

Raises:

Type Description
KeyError

If the component is not found.
Source code in gamms/typing/recorder.py 
124
125
126
127
128
129
130
131
132
133
134
135
136
@abstractmethod
def delete_component(self, name: str) -> None:
    """
    Delete the component from the name.

    Args:
        name (str): Name of the component.

    Raises:
        KeyError: If the component is not found.

    """
    pass

get_component(name) abstractmethod

Get the component from the name.

Parameters:

Name Type Description Default
name str

Name of the component.

 required

Returns:

Type Description
object

Type[_T]: Component object.

Raises:

Type Description
KeyError

If the component is not found.
Source code in gamms/typing/recorder.py 
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
@abstractmethod
def get_component(self, name: str) -> object:
    """
    Get the component from the name.

    Args:
        name (str): Name of the component.

    Returns:
        Type[_T]: Component object.

    Raises:
        KeyError: If the component is not found.
    """
    pass

is_component_registered(key) abstractmethod

Check if the component is registered. Key is (module_name, qualname)

Parameters:

Name Type Description Default
key Tuple[str, str]

Key to check.

 required

Returns:

Name Type Description
bool bool

True if registered, False otherwise.
Source code in gamms/typing/recorder.py 
159
160
161
162
163
164
165
166
167
168
169
170
171
@abstractmethod
def is_component_registered(self, key: Tuple[str, str]) -> bool:
    """
    Check if the component is registered.
    Key is (module_name, qualname)

    Args:
        key (Tuple[str, str]): Key to check.

    Returns:
        bool: True if registered, False otherwise.
    """
    pass

pause() abstractmethod

Pause the recording process. self.record() should return false if paused. If not started or stopped, give warning.

Source code in gamms/typing/recorder.py 
45
46
47
48
49
50
@abstractmethod
def pause(self) -> None:
    """
    Pause the recording process. `self.record()` should return false if paused.  If not started or stopped, give warning.
    """
    pass

play() abstractmethod

Resume recording if paused. If not started or stopped, give warning.

Source code in gamms/typing/recorder.py 
51
52
53
54
55
56
@abstractmethod
def play(self) -> None:
    """
    Resume recording if paused. If not started or stopped, give warning.
    """
    pass

record() abstractmethod

Boolean to inform whether game is being recorded or not and ctx is alive

Returns:

Name Type Description
bool bool

True if recording, False otherwise
Source code in gamms/typing/recorder.py 
10
11
12
13
14
15
16
17
18
@abstractmethod
def record(self) -> bool:
    """
    Boolean to inform whether game is being recorded or not and ctx is alive

    Returns:
        bool: True if recording, False otherwise
    """
    pass

replay(path) abstractmethod

Checks validity of the file and output an iterator.

Parameters:

Name Type Description Default
path Union[str, BinaryIO]

Path to the recording file.

 required

Returns:

Name Type Description
Iterator Iterator[Dict[str, Any]]

Iterator to replay the recording.

Raises:

Type Description
RuntimeError

If replay is already in progress.
FileNotFoundError

If the file does not exist.
TypeError

If the path is not a string or file object.
ValueError

If the file is not a valid recording file or if recording terminated unexpectedly.
ValueError

If the version of the file is not supported.
Source code in gamms/typing/recorder.py 
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
@abstractmethod    
def replay(self, path: Union[str, BinaryIO]) -> Iterator[Dict[str, Any]]:
    """
    Checks validity of the file and output an iterator.

    Args:
        path (Union[str, BinaryIO]): Path to the recording file.

    Returns:
        Iterator: Iterator to replay the recording.

    Raises:
        RuntimeError: If replay is already in progress.
        FileNotFoundError: If the file does not exist.
        TypeError: If the path is not a string or file object.
        ValueError: If the file is not a valid recording file or if recording terminated unexpectedly.
        ValueError: If the version of the file is not supported.
    """
    pass

start(path) abstractmethod

Start recording to the path. Raise error if file already exists Adds ".ggr" extension if not present.

If path is a file object, it will be used as the file handler.

Parameters:

Name Type Description Default
path Union[str, BinaryIO]

Path to record the game.

 required

Raises:

Type Description
FileExistsError

If the file already exists.
TypeError

If the path is not a string or file object.
Source code in gamms/typing/recorder.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
@abstractmethod
def start(self, path: Union[str, BinaryIO]) -> None:
    """
    Start recording to the path. Raise error if file already exists
    Adds ".ggr" extension if not present.

    If path is a file object, it will be used as the file handler.

    Args:
        path (Union[str, BinaryIO]): Path to record the game.

    Raises:
        FileExistsError: If the file already exists.
        TypeError: If the path is not a string or file object.
    """
    pass

stop() abstractmethod

Stop recording to the path and close the file handler.

Raises:

Type Description
RuntimeError

If recording has not started.
Source code in gamms/typing/recorder.py 
36
37
38
39
40
41
42
43
44
@abstractmethod
def stop(self) -> None:
    """
    Stop recording to the path and close the file handler.

    Raises:
        RuntimeError: If recording has not started.
    """
    pass

time() abstractmethod

Return record time if replaying. Else return the local time (time.time()) in nano seconds.

Returns:

Name Type Description
int int

Time in nanoseconds.
Source code in gamms/typing/recorder.py 
76
77
78
79
80
81
82
83
84
@abstractmethod
def time(self) -> int:
    """
    Return record time if replaying. Else return the local time `(time.time())` in nano seconds.

    Returns:
        int: Time in nanoseconds.
    """
    pass

unregister_component(key) abstractmethod

Unregister the component. Key is (module_name, qualname)

Parameters:

Name Type Description Default
key Tuple[str, str]

Key to unregister.

 required

Raises:

Type Description
KeyError

If the component is not found.
Source code in gamms/typing/recorder.py 
173
174
175
176
177
178
179
180
181
182
183
184
185
@abstractmethod
def unregister_component(self, key: Tuple[str, str]) -> None:
    """
    Unregister the component.
    Key is (module_name, qualname)

    Args:
        key (Tuple[str, str]): Key to unregister.

    Raises:
        KeyError: If the component is not found.
    """
    pass

write(opCode, data) abstractmethod

Write to record buffer if recording. If not recording raise error as it should not happen.

WARNING: This function should not be required to be called by the user in most cases.

Source code in gamms/typing/recorder.py 
85
86
87
88
89
90
91
92
@abstractmethod
def write(self, opCode: OpCodes, data: Dict[str, JsonType]) -> None:
    """
    Write to record buffer if recording. If not recording raise error as it should not happen.

    WARNING: This function should not be required to be called by the user in most cases.
    """
    pass