eolib 1.0.0__tar.gz → 1.1.0__tar.gz

{eolib-1.0.0 → eolib-1.1.0}/.github/workflows/lint.yml

@@ -1,4 +1,4 @@
-name: Lint
+name: lint
 
 on:
   push:

{eolib-1.0.0 → eolib-1.1.0}/.github/workflows/release.yml

@@ -1,4 +1,4 @@
-name: Release
+name: release
 
 on:
   push:
@@ -39,6 +39,8 @@ jobs:
 
       - name: Push Python artifacts to PyPI
         uses: pypa/gh-action-pypi-publish@v1.8.10
+        with:
+          skip-existing: true
 
   publish-docs:
     needs: publish-pypi
@@ -68,11 +70,15 @@ jobs:
           git config user.name github-actions
           git config user.email github-actions@github.com
           hatch run docs:deploy ${{ steps.get-version.outputs.version-without-v }}
+          git push origin gh-pages
  
   publish-github:
     needs: publish-docs
     runs-on: ubuntu-latest
 
+    permissions:
+      contents: write
+
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -91,5 +97,5 @@ jobs:
       - name: Create Release
         uses: softprops/action-gh-release@v1
         with:
-          name: ${{ steps.changelog.outputs.version }}
+          name: EOLib ${{ steps.get-version.outputs.version }}
           body: ${{ steps.changelog.outputs.release-notes }}

{eolib-1.0.0 → eolib-1.1.0}/.github/workflows/sonar.yml

@@ -1,4 +1,4 @@
-name: Sonar
+name: sonar
 
 on:
   push:

{eolib-1.0.0 → eolib-1.1.0}/.github/workflows/test.yml

@@ -1,4 +1,4 @@
-name: Test
+name: test
 
 on:
   push:

{eolib-1.0.0 → eolib-1.1.0}/CHANGELOG.md

@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.1.0] - 2023-12-19
+
+### Added
+
+- `WalkPlayerServerPacket.direction` field.
+
+### Changed
+
+- Remove trailing break from `ArenaSpecServerPacket`.
+- Remove trailing break from `ArenaAcceptServerPacket`.
+- Deprecate `WalkPlayerServerPacket.Direction` field.
+
 ## [1.0.0] - 2023-11-07
 
 ### Added
@@ -27,5 +39,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Data encryption
   - Packet sequencer
 
-[Unreleased]: https://github.com/cirras/eolib-python/compare/v1.0.0...HEAD
+[Unreleased]: https://github.com/cirras/eolib-python/compare/v1.1.0...HEAD
+[1.1.0]: https://github.com/cirras/eolib-python/compare/v1.0.0...v1.1.0
 [1.0.0]: https://github.com/cirras/eolib-python/releases/tag/v1.0.0

{eolib-1.0.0 → eolib-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: eolib
-Version: 1.0.0
+Version: 1.1.0
 Summary: Core library for writing applications related to Endless Online.
 Project-URL: Documentation, https://github.com/Cirras/eolib#readme
 Project-URL: Issues, https://github.com/Cirras/eolib/issues
@@ -9,7 +9,7 @@ Author-email: Jonah Jeleniewski <cirrasbu@hotmail.com>
 License-Expression: MIT
 License-File: LICENSE.txt
 Keywords: endless-online
-Classifier: Development Status :: 4 - Beta
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9

eolib-1.1.0/eo-protocol/README.md

@@ -0,0 +1,43 @@
+# EO Protocol
+
+An XML-based specification of the Endless Online network protocol and data files.
+
+## Motivation
+
+Most of this information has been available for some time. It's been scattered through different projects, only partially documented, or living in the heads of various community members.
+
+The idea is to put all of that collective knowledge in one place.
+
+## Use cases
+
+- Documentation
+- Code generation
+
+## Projects
+
+Community projects based on this specification.
+
+### Libraries
+
+1. **[eolib-go](https://github.com/ethanmoffat/eolib-go)** ([@ethanmoffat](https://github.com/ethanmoffat))
+    * Core Golang library for writing Endless Online applications.
+2. **[eolib-java](https://github.com/cirras/eolib-java)** ([@cirras](https://github.com/cirras))
+    * Core Java library for writing Endless Online applications.
+3. **[eolib-python](https://github.com/cirras/eolib-python)** ([@cirras](https://github.com/cirras))
+    * Core Python library for writing Endless Online applications.
+4. **[eolib-ts](https://github.com/cirras/eolib-ts)** ([@cirras](https://github.com/cirras))
+    * Core Typescript library for writing Endless Online applications.
+
+### Documentation
+
+1. **[eo-protocol-web](https://eoserv.net/eo-protocol-web/)** ([@tehsausage](https://github.com/tehsausage))
+    * Generated protocol documentation site.
+
+## Acknowledgements
+
+- Julian Smythe
+  - The `eo_protocol.txt` and `pub_protocol.txt` documentation that this project is based on, which was [released](https://eoserv.net/forum/topic/23799) in 2017 on the EOSERV forums.
+  - The [EOSERV](https://github.com/eoserv/eoserv) project, which has been a valuable reference point.
+  - Answering questions that none of us even knew we had about the protocol and official packet reader.
+- Richard Leek
+  - Improvements and corrections to the aforementioned `eo_protocol.txt` and `pub_protocol.txt` documentation. (See [eo_protocol](https://github.com/sorokya/eo_protocol))

{eolib-1.0.0 → eolib-1.1.0}/eo-protocol/xml/net/server/protocol.xml

@@ -1442,7 +1442,7 @@
     <packet family="Walk" action="Player">
         <comment>Nearby player has walked</comment>
         <field name="player_id" type="short"/>
-        <field name="Direction" type="Direction"/>
+        <field name="direction" type="Direction"/>
         <field name="coords" type="Coords"/>
     </packet>
 
@@ -2377,7 +2377,6 @@
             <field name="killer_name" type="string"/>
             <break/>
             <field name="victim_name" type="string"/>
-            <break/>
         </chunked>
     </packet>
 
@@ -2391,7 +2390,6 @@
             <field name="killer_name" type="string"/>
             <break/>
             <field name="victim_name" type="string"/>
-            <break/>
         </chunked>
     </packet>
 

{eolib-1.0.0 → eolib-1.1.0}/mkdocs.yml

@@ -54,4 +54,5 @@ plugins:
           summary: true
           filters: ["!^_[^_]", "!^__repr__$", "!^__all__$"]
 markdown_extensions:
+  - admonition
   - attr_list

{eolib-1.0.0 → eolib-1.1.0}/protocol_code_generator/generate/field_code_generator.py

@@ -1,3 +1,4 @@
+from collections import namedtuple
 from protocol_code_generator.generate.code_block import CodeBlock
 from protocol_code_generator.generate.object_code_generator import FieldData
 from protocol_code_generator.type.basic_type import BasicType
@@ -13,6 +14,19 @@ from protocol_code_generator.type.struct_type import StructType
 from protocol_code_generator.util.docstring_utils import generate_docstring
 from protocol_code_generator.util.number_utils import try_parse_int
 
+DeprecatedField = namedtuple(
+    "DeprecatedField", ["type_name", "old_field_name", "new_field_name", "since"]
+)
+
+DEPRECATED_FIELDS = [DeprecatedField("WalkPlayerServerPacket", "Direction", "direction", "1.1.0")]
+
+
+def get_deprecated_field(type_name, field_name):
+    for field in DEPRECATED_FIELDS:
+        if field.type_name == type_name and field.new_field_name == field_name:
+            return field
+    return None
+
 
 class FieldCodeGenerator:
     def __init__(
@@ -233,6 +247,43 @@ class FieldCodeGenerator:
             setter.unindent()
             self._data.add_method(setter)
 
+        deprecated = get_deprecated_field(self._data.class_name, self._name)
+        if deprecated is not None:
+            old_name = deprecated.old_field_name
+            deprecated_docstring = (
+                CodeBlock()
+                .add_line('"""')
+                .add_line('!!! warning "Deprecated"')
+                .add_line()
+                .add_line(f"    Use `{self._name}` instead. (Deprecated since v{deprecated.since})")
+                .add_line('"""')
+            )
+            deprecation_warning = (
+                f"'{self._data.class_name}.{deprecated.old_field_name}' is deprecated as of "
+                f"{deprecated.since}, use '{self._name}' instead."
+            )
+            self._data.add_method(
+                CodeBlock()
+                .add_line('@property')
+                .add_line(f'def {old_name}(self) -> {python_type_name}:')
+                .indent()
+                .add_code_block(deprecated_docstring)
+                .add_line(f'warn("{deprecation_warning}", DeprecationWarning, stacklevel=2)')
+                .add_line(f'return self.{self._name}')
+                .unindent()
+                .add_import("warn", "warnings")
+            )
+            if self._hardcoded_value is None:
+                self._data.add_method(
+                    CodeBlock()
+                    .add_line(f'@{old_name}.setter')
+                    .add_line(f'def {old_name}(self, {self._name}: {python_type_name}) -> None:')
+                    .indent()
+                    .add_code_block(deprecated_docstring)
+                    .add_line(f'self.{self._name} = {self._name}')
+                    .unindent()
+                )
+
     def generate_serialize(self):
         self._generate_serialize_missing_optional_guard()
         self._generate_serialize_none_not_allowed_error()

{eolib-1.0.0 → eolib-1.1.0}/pyproject.toml

@@ -14,7 +14,7 @@ authors = [
   { name = "Jonah Jeleniewski", email = "cirrasbu@hotmail.com" },
 ]
 classifiers = [
-  "Development Status :: 4 - Beta",
+  "Development Status :: 5 - Production/Stable",
   "Programming Language :: Python",
   "Programming Language :: Python :: 3.8",
   "Programming Language :: Python :: 3.9",

eolib-1.1.0/src/eolib/__about__.py

@@ -0,0 +1 @@
+__version__ = "1.1.0"

{eolib-1.0.0 → eolib-1.1.0}/src/eolib/packet/sequence_start.py

@@ -93,7 +93,7 @@ class InitSequenceStart(SimpleSequenceStart):
     @property
     def seq1(self) -> int:
         """
-        Returns the `seq1` byte value sent with the INIT_INIT server packet.
+        Returns the `seq1` byte value sent with the `INIT_INIT` server packet.
 
         Returns:
             int: The seq1 byte value.
@@ -103,7 +103,7 @@ class InitSequenceStart(SimpleSequenceStart):
     @property
     def seq2(self) -> int:
         """
-        Returns the `seq2` byte value sent with the INIT_INIT server packet.
+        Returns the `seq2` byte value sent with the `INIT_INIT` server packet.
 
         Returns:
             int: The seq2 byte value.
@@ -170,7 +170,7 @@ class PingSequenceStart(SimpleSequenceStart):
     @property
     def seq2(self) -> int:
         """
-        Returns the seq2 char value sent with the CONNECTION_PLAYER server packet.
+        Returns the seq2 char value sent with the `CONNECTION_PLAYER` server packet.
 
         Returns:
             int: The seq2 char value.

{eolib-1.0.0 → eolib-1.1.0}/src/eolib/protocol/_generated/net/server/arena_accept_server_packet.py

@@ -120,7 +120,6 @@ class ArenaAcceptServerPacket(Packet):
         if data._victim_name is None:
             raise SerializationError("victim_name must be provided.")
         writer.add_string(data._victim_name)
-        writer.add_byte(0xFF)
 
     @staticmethod
     def deserialize(reader: EoReader) -> "ArenaAcceptServerPacket":
@@ -145,7 +144,6 @@ class ArenaAcceptServerPacket(Packet):
             data._killer_name = reader.get_string()
             reader.next_chunk()
             data._victim_name = reader.get_string()
-            reader.next_chunk()
             reader.chunked_reading_mode = False
             data._byte_size = reader.position - reader_start_position
             return data

{eolib-1.0.0 → eolib-1.1.0}/src/eolib/protocol/_generated/net/server/arena_spec_server_packet.py

@@ -142,7 +142,6 @@ class ArenaSpecServerPacket(Packet):
         if data._victim_name is None:
             raise SerializationError("victim_name must be provided.")
         writer.add_string(data._victim_name)
-        writer.add_byte(0xFF)
 
     @staticmethod
     def deserialize(reader: EoReader) -> "ArenaSpecServerPacket":
@@ -169,7 +168,6 @@ class ArenaSpecServerPacket(Packet):
             data._killer_name = reader.get_string()
             reader.next_chunk()
             data._victim_name = reader.get_string()
-            reader.next_chunk()
             reader.chunked_reading_mode = False
             data._byte_size = reader.position - reader_start_position
             return data

{eolib-1.0.0 → eolib-1.1.0}/src/eolib/protocol/_generated/net/server/walk_player_server_packet.py

@@ -3,6 +3,7 @@
 # This file should not be modified.
 # Changes will be lost when code is regenerated.
 
+from warnings import warn
 from ..packet_family import PacketFamily
 from ..packet_action import PacketAction
 from ...direction import Direction
@@ -15,7 +16,7 @@ from .....data.eo_reader import EoReader
 class WalkPlayerServerPacket(Packet):
     _byte_size: int = 0
     _player_id: int = None # type: ignore [assignment]
-    _Direction: Direction = None # type: ignore [assignment]
+    _direction: Direction = None # type: ignore [assignment]
     _coords: Coords = None # type: ignore [assignment]
 
     @property
@@ -44,13 +45,32 @@ class WalkPlayerServerPacket(Packet):
         """
         self._player_id = player_id
 
+    @property
+    def direction(self) -> Direction:
+        return self._direction
+
+    @direction.setter
+    def direction(self, direction: Direction) -> None:
+        self._direction = direction
+
     @property
     def Direction(self) -> Direction:
-        return self._Direction
+        """
+        !!! warning "Deprecated"
+
+            Use `direction` instead. (Deprecated since v1.1.0)
+        """
+        warn("'WalkPlayerServerPacket.Direction' is deprecated as of 1.1.0, use 'direction' instead.", DeprecationWarning, stacklevel=2)
+        return self.direction
 
     @Direction.setter
-    def Direction(self, Direction: Direction) -> None:
-        self._Direction = Direction
+    def Direction(self, direction: Direction) -> None:
+        """
+        !!! warning "Deprecated"
+
+            Use `direction` instead. (Deprecated since v1.1.0)
+        """
+        self.direction = direction
 
     @property
     def coords(self) -> Coords:
@@ -101,9 +121,9 @@ class WalkPlayerServerPacket(Packet):
         if data._player_id is None:
             raise SerializationError("player_id must be provided.")
         writer.add_short(data._player_id)
-        if data._Direction is None:
-            raise SerializationError("Direction must be provided.")
-        writer.add_char(int(data._Direction))
+        if data._direction is None:
+            raise SerializationError("direction must be provided.")
+        writer.add_char(int(data._direction))
         if data._coords is None:
             raise SerializationError("coords must be provided.")
         Coords.serialize(writer, data._coords)
@@ -124,7 +144,7 @@ class WalkPlayerServerPacket(Packet):
         try:
             reader_start_position: int = reader.position
             data._player_id = reader.get_short()
-            data._Direction = Direction(reader.get_char())
+            data._direction = Direction(reader.get_char())
             data._coords = Coords.deserialize(reader)
             data._byte_size = reader.position - reader_start_position
             return data
@@ -132,4 +152,4 @@ class WalkPlayerServerPacket(Packet):
             reader.chunked_reading_mode = old_chunked_reading_mode
 
     def __repr__(self):
-        return f"WalkPlayerServerPacket(byte_size={repr(self._byte_size)}, player_id={repr(self._player_id)}, Direction={repr(self._Direction)}, coords={repr(self._coords)})"
+        return f"WalkPlayerServerPacket(byte_size={repr(self._byte_size)}, player_id={repr(self._player_id)}, direction={repr(self._direction)}, coords={repr(self._coords)})"

eolib-1.0.0/eo-protocol/README.md

@@ -1,19 +0,0 @@
-# EO Protocol
-An XML-based representation of the Endless Online network protocol and data files.
-
-## Motivation
-Most of this information has been available for some time. It's been scattered through different projects, only partially documented, or living in the heads of various community members.
-
-The idea is to put all of that collective knowledge in one place.
-
-## Use cases
-- Documentation
-- Code generation
-
-## Acknowledgements
-- Julian Smythe
-  - The `eo_protocol.txt` and `pub_protocol.txt` documentation that this project is based on, which was [released](https://eoserv.net/forum/topic/23799) in 2017 on the EOSERV forums.
-  - The [EOSERV](https://github.com/eoserv/eoserv) project, which has been a valuable reference point.
-  - Answering questions that none of us even knew we had about the protocol and official packet reader.
-- Richard Leek
-  - Improvements and corrections to the aforementioned `eo_protocol.txt` and `pub_protocol.txt` documentation. (See [eo_protocol](https://github.com/sorokya/eo_protocol))

eolib-1.0.0/src/eolib/__about__.py

@@ -1 +0,0 @@
-__version__ = "1.0.0"