wzrdbrain 0.1.3__py3-none-any.whl → 0.1.4__py3-none-any.whl

wzrdbrain/__init__.py

@@ -1,10 +1,10 @@
-from .wzrdbrain import generate_combo, generate_trick
+from .wzrdbrain import generate_combo
 
 """
 wzrdbrain: Basic APIs to generate tricks for wizard skating.
 """
 
 
-__all__ = ["generate_trick", "generate_combo"]
+__all__ = ["generate_combo"]
 
 __version__ = "0.1.0"

wzrdbrain/wzrdbrain.py

@@ -1,10 +1,11 @@
 import random
-from typing import Optional
+from typing import Optional, Any
+from dataclasses import dataclass, asdict
 
 # Trick data definitions
-direction = ("front", "back")
-stance = ("open", "closed")
-move = (
+DIRECTIONS = ("front", "back")
+STANCES = ("open", "closed")
+MOVES = (
     "predator",
     "predator one",
     "parallel",
@@ -19,6 +20,7 @@ move = (
     "heel roll",
     "360",
     "180",
+    "540",  # Added missing move
     "parallel slide",
     "soul slide",
     "acid slide",
@@ -27,6 +29,8 @@ move = (
     "fast slide",
     "back slide",
 )
+# Moves that only occurs as the first trick for a combo
+only_first = {"predator", "predator one", "parallel"}
 
 # Moves that use "fakie" instead of "back"
 use_fakie = {
@@ -36,6 +40,7 @@ use_fakie = {
     "heel roll",
     "360",
     "180",
+    "540",
     "parallel slide",
     "soul slide",
     "acid slide",
@@ -52,33 +57,103 @@ exclude_stance = {
 }.union(use_fakie)
 
 
-# Generate a trick
-def generate_trick() -> list[str]:
-    selected_move = random.choice(move)
-    trick = [random.choice(direction)]
+@dataclass
+class Trick:
+    direction: Optional[str] = None
+    stance: Optional[str] = None
+    move: Optional[str] = None
+    enter_into_trick: Optional[str] = None
+    exit_from_trick: Optional[str] = None
 
-    if selected_move not in exclude_stance:
-        trick.append(random.choice(stance))
+    def __post_init__(self) -> None:
+        """
+        Validate inputs and set random defaults for any attributes that were not provided.
+        """
+        # Input validation
+        if self.direction is not None and self.direction not in DIRECTIONS:
+            raise ValueError(f"Invalid direction: '{self.direction}'. Must be one of {DIRECTIONS}")
+        if self.stance is not None and self.stance not in STANCES:
+            raise ValueError(f"Invalid stance: '{self.stance}'. Must be one of {STANCES}")
+        if self.move is not None and self.move not in MOVES:
+            raise ValueError(f"Invalid move: '{self.move}'. Must be one of {MOVES}")
 
-    trick.append(selected_move)
-    return trick
+        # Generate default values
+        if self.direction is None:
+            self.direction = random.choice(DIRECTIONS)
 
+        if self.move is None:
+            self.move = random.choice(MOVES)
 
-# Generate a combination of tricks. Default setting is random, between 1-5 tricks.
-def generate_combo(num_of_tricks: Optional[int] = None) -> list[str]:
+        if self.enter_into_trick is None:
+            self.enter_into_trick = self.direction
+
+        if self.exit_from_trick is None:
+            self.exit_from_trick = self.direction
+
+        # Automatically determine stance if not provided
+        if self.stance is None and self.move not in exclude_stance:
+            self.stance = random.choice(STANCES)
+
+        # Update exit direction for moves that rotate the body
+        if self.move in ["gazelle", "lion", "180", "540"]:
+            if self.direction == "back":
+                self.exit_from_trick = "front"
+            elif self.direction == "front":
+                self.exit_from_trick = "back"
+
+    def __str__(self) -> str:
+        parts = []
+        display_direction = self.direction
+        # Handle fakie/forward display name
+        if self.move in use_fakie:
+            if self.direction == "back":
+                display_direction = "fakie"
+            elif self.direction == "front":
+                display_direction = "forward"
+
+        if display_direction:
+            parts.append(display_direction)
+        if self.stance:
+            parts.append(self.stance)
+        if self.move:
+            parts.append(self.move)
+
+        return " ".join(parts)
+
+    def to_dict(self) -> dict[str, Any]:
+        """Returns a dictionary representation of the trick, including its full name."""
+        data = asdict(self)
+        data["name"] = str(self)
+        return data
+
+
+# Generate a combination of tricks. Default is a random number from 2 until 5.
+def generate_combo(num_of_tricks: Optional[int] = None) -> list[dict[str, Any]]:
     if num_of_tricks is None:
-        num_of_tricks = random.randint(1, 5)
-
-    trick_line: list[str] = []
-    for i in range(num_of_tricks):
-        trick_parts = generate_trick()
-        # If the move uses the fakie semantics, convert the direction "front"/"back" to "forward"/"fakie"
-        if trick_parts:
-            move_name = trick_parts[-1]
-            if move_name in use_fakie:
-                if trick_parts[0] == "back":
-                    trick_parts[0] = "fakie"
-                elif trick_parts[0] == "front":
-                    trick_parts[0] = "forward"
-        trick_line.append(" ".join(trick_parts))
-    return trick_line
+        num_of_tricks = random.randint(2, 5)
+
+    if num_of_tricks <= 0:
+        return []
+
+    trick_objects: list[Trick] = []
+    previous_trick: Optional[Trick] = None
+
+    for _ in range(num_of_tricks):
+        if previous_trick is None:
+            # Generate the first trick without constraints
+            new_trick = Trick()
+        else:
+            # Generate subsequent tricks based on the previous one's exit
+            required_direction = previous_trick.exit_from_trick
+            # Loop until we generate a valid trick for this position
+            while True:
+                candidate_trick = Trick(direction=required_direction)
+                if candidate_trick.move not in only_first:
+                    new_trick = candidate_trick
+                    break
+
+        trick_objects.append(new_trick)
+        previous_trick = new_trick
+
+    # Convert all trick objects to dictionaries for the final output
+    return [trick.to_dict() for trick in trick_objects]

wzrdbrain-0.1.4.dist-info/METADATA

@@ -0,0 +1,107 @@
+Metadata-Version: 2.4
+Name: wzrdbrain
+Version: 0.1.4
+Summary: A simple library to generate trick combinations for wizard skating.
+Author: nazroll
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/nazroll/wzrdbrain
+Project-URL: Documentation, https://github.com/nazroll/wzrdbrain#readme
+Project-URL: Repository, https://github.com/nazroll/wzrdbrain
+Project-URL: Issues, https://github.com/nazroll/wzrdbrain/issues
+Keywords: wizard skating,tricks,random,generator,inline skating
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Games/Entertainment
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Dynamic: license-file
+
+# wzrdbrain
+
+A library to generate random trick combinations for wizard skating.
+
+## Installation
+
+```bash
+pip install wzrdbrain
+```
+
+## Usage
+
+The primary function is `generate_combo`, which returns a list of trick dictionaries. You can also create `Trick` objects directly for more control.
+
+```python
+from wzrdbrain import generate_combo, Trick
+
+# Generate a combo of 3 tricks
+combo = generate_combo(3)
+
+# The output is a list of dictionaries, each representing a trick
+# print(combo)
+# Example output:
+# [
+#     {
+#         'direction': 'front', 'stance': 'open', 'move': 'gazelle', 
+#         'enter_into_trick': 'front', 'exit_from_trick': 'back', 
+#         'name': 'front open gazelle'
+#     },
+#     {
+#         'direction': 'back', 'stance': None, 'move': '360', 
+#         'enter_into_trick': 'back', 'exit_from_trick': 'back', 
+#         'name': 'fakie 360'
+#     },
+#     # ... and so on
+# ]
+
+# To get just the names of the tricks in the combo:
+trick_names = [trick['name'] for trick in combo]
+print(trick_names)
+# Example output: ['front open gazelle', 'fakie 360', 'back open lion']
+```
+
+### Creating a Trick Object
+
+You can create a `Trick` object with specific attributes. Any attributes not provided will be randomly generated.
+
+```python
+# Create a trick with a specific move
+my_trick = Trick(move="lion s")
+
+# Print the full trick object as a dictionary
+print(my_trick.to_dict())
+# Example output:
+# {
+#     'direction': 'back', 'stance': 'closed', 'move': 'lion s', 
+#     'enter_into_trick': 'back', 'exit_from_trick': 'back', 
+#     'name': 'back closed lion s'
+# }
+```
+
+## Development
+
+To contribute to this project, please see the [Contributing Guide](CONTRIBUTING.md).
+
+First, clone the repository and install the project in editable mode with its development dependencies:
+
+```bash
+git clone https://github.com/nazroll/wzrdbrain.git
+cd wzrdbrain
+pip install -e .[dev]
+```
+
+You can run the test suite using `pytest`:
+
+```bash
+pytest
+```
+
+## List of wizard skating tricks
+
+The list of tricks in this library is not comprehensive. Please create an issue and give us your suggestions of new tricks

wzrdbrain-0.1.4.dist-info/RECORD

@@ -0,0 +1,7 @@
+wzrdbrain/__init__.py,sha256=-b4GWOA6aZBzfRZTmxMCc8QyLTx5NQlBxL_g0-4hK98,162
+wzrdbrain/wzrdbrain.py,sha256=I5j6jWg_P1RI6Pxm2PVsOxYtiwOg4okjziRGt6mbnVM,4779
+wzrdbrain-0.1.4.dist-info/licenses/LICENSE,sha256=5cb0zgcuOCZO8R90wtzkxKYMTdgGLswLH9UHj9ATUoU,11351
+wzrdbrain-0.1.4.dist-info/METADATA,sha256=S9h6hT7eaTky4N25BHJO9Jns2sG0oOeCytV47MVMHnw,3077
+wzrdbrain-0.1.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+wzrdbrain-0.1.4.dist-info/top_level.txt,sha256=v5QVWmDcidVAN1NXyn-i9mFxfzSkvGqCRjHs2qyNmLk,10
+wzrdbrain-0.1.4.dist-info/RECORD,,

{wzrdbrain-0.1.3.dist-info → wzrdbrain-0.1.4.dist-info}/WHEEL

@@ -1,4 +1,5 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.27.0
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
+

wzrdbrain-0.1.4.dist-info/top_level.txt

@@ -0,0 +1 @@
+wzrdbrain

wzrdbrain-0.1.3.dist-info/METADATA

@@ -1,66 +0,0 @@
-Metadata-Version: 2.4
-Name: wzrdbrain
-Version: 0.1.3
-Summary: A simple library to generate random trick combinations for wizard skating.
-Project-URL: Homepage, https://github.com/nazroll/wzrdbrain
-Project-URL: Documentation, https://github.com/nazroll/wzrdbrain#readme
-Project-URL: Repository, https://github.com/nazroll/wzrdbrain
-Project-URL: Issues, https://github.com/nazroll/wzrdbrain/issues
-Author: nazroll
-License-Expression: Apache-2.0
-License-File: LICENSE
-Keywords: generator,inline skating,random,tricks,wizard skating
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Topic :: Games/Entertainment
-Classifier: Topic :: Software Development :: Libraries
-Classifier: Typing :: Typed
-Requires-Python: >=3.9
-Provides-Extra: dev
-Requires-Dist: black>=24.3; extra == 'dev'
-Requires-Dist: build>=1.2; extra == 'dev'
-Requires-Dist: mypy>=1.10; extra == 'dev'
-Requires-Dist: pytest>=8; extra == 'dev'
-Requires-Dist: ruff>=0.5; extra == 'dev'
-Description-Content-Type: text/markdown
-
-# wzrdbrain
-
-A simple library to generate random trick combinations for wizard skating.
-
-## Installation
-
-```bash
-pip install wzrdbrain
-```
-
-## Usage
-
-```python
-from wzrdbrain import generate_trick, generate_combo
-
-# Generate a single trick as a list of its parts
-print(generate_trick())
-# Example output: ['front', 'open', 'lion']
-
-# Generate a line of multiple tricks as formatted strings
-print(generate_combo(3))
-# Example output: ['front parallel', 'fakie toe press', 'forward 360']
-```
-
-## List of wizard skating tricks
-
-The list of tricks in this library is not comprehensive. Please create an issue and give us your suggestions of new tricks to be added.
-
-## Contributing
-
-Contributions are welcome! Please see the [Contributing Guide](CONTRIBUTING.md) for details on how to set up your development environment, run tests, and submit changes.

wzrdbrain-0.1.3.dist-info/RECORD

@@ -1,6 +0,0 @@
-wzrdbrain/__init__.py,sha256=trIv6PSyva-qbi3Qjyzu7PAvkZoFT33709p47wHFXFg,196
-wzrdbrain/wzrdbrain.py,sha256=jzo4gqiorLL_CSV2aFM3ep6aIcj9o8V6ym81D7FfvYY,1955
-wzrdbrain-0.1.3.dist-info/METADATA,sha256=48RG22JRhkAZTay0E4IFTBQYbRIKeU0sJxs6TRyaEl0,2360
-wzrdbrain-0.1.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-wzrdbrain-0.1.3.dist-info/licenses/LICENSE,sha256=5cb0zgcuOCZO8R90wtzkxKYMTdgGLswLH9UHj9ATUoU,11351
-wzrdbrain-0.1.3.dist-info/RECORD,,