rename DiceShell->Shell since a subject is clear from containing package ns - godice.Shell

Author: anton-ptashnik

README.md

@@ -55,7 +55,7 @@ async def main():
     # Python context manager (async with) is used for convenient connection handling
     # Device stays connected during `async with` block execution and auto-disconnected on block finish
     # Otherwise, dice.connect/dice.disconnect can be used instead 
-    async with godice.create(client, godice.DiceShell.D6) as dice:
+    async with godice.create(client, godice.Shell.D6) as dice:
 		print("Connected")
         blue_rgb = (0, 0, 255)
         yellow_rgb = (255, 255, 0)

godice/__init__.py

@@ -6,7 +6,7 @@
 from .factory import (
     create,
     set_shell,
-    DiceShell
+    Shell
 )
 from .dice import (
     StabilityDescriptor,

godice/demo.py

@@ -22,7 +22,7 @@ async def main():
     # Python context manager (async with) is used for convenient connection handling
     # Device stays connected during `async with` block execution and auto-disconnected on block finish
     # Otherwise, dice.connect/dice.disconnect can be used instead 
-    async with godice.create(client, godice.DiceShell.D6) as dice:
+    async with godice.create(client, godice.Shell.D6) as dice:
         print(f"Connected to {dev.name}")
 
         blue_rgb = (0, 0, 255)

godice/factory.py

@@ -8,7 +8,7 @@
 from . import xyzinterpret
 
 
-class DiceShell(enum.Enum):
+class Shell(enum.Enum):
     """
     Available shells a dice may be wrapped into
     """
@@ -21,33 +21,33 @@ class DiceShell(enum.Enum):
     D12 = 6
 
 xyz_interpret_map = {
-    DiceShell.D6: xyzinterpret.get_rolled_number_d6,
-    DiceShell.D10: xyzinterpret.get_rolled_number_d10,
-    DiceShell.D10X: xyzinterpret.get_rolled_number_d10x,
-    DiceShell.D20: xyzinterpret.get_rolled_number_d20,
-    DiceShell.D4: xyzinterpret.get_rolled_number_d4,
-    DiceShell.D8: xyzinterpret.get_rolled_number_d8,
-    DiceShell.D12: xyzinterpret.get_rolled_number_d12,
+    Shell.D6: xyzinterpret.get_rolled_number_d6,
+    Shell.D10: xyzinterpret.get_rolled_number_d10,
+    Shell.D10X: xyzinterpret.get_rolled_number_d10x,
+    Shell.D20: xyzinterpret.get_rolled_number_d20,
+    Shell.D4: xyzinterpret.get_rolled_number_d4,
+    Shell.D8: xyzinterpret.get_rolled_number_d8,
+    Shell.D12: xyzinterpret.get_rolled_number_d12,
 }
 
 
-def create(ble_client: bleak.BleakClient, dice_shell: DiceShell):
+def create(ble_client: bleak.BleakClient, dice_shell: Shell):
     """
     Creates Dice API object representing the specified type of a dice
     :param ble_client: BleakClient
-    :param dice_shell: DiceShell
+    :param dice_shell: Shell
     """
     _dice = dice.Dice(ble_client)
     set_shell(_dice, dice_shell)
     return _dice
 
 
-def set_shell(_dice: dice.Dice, dice_shell: DiceShell):
+def set_shell(_dice: dice.Dice, dice_shell: Shell):
     """
     Change a dice shell.
     Should be called in order to receive correct number notifications corresponding to a newly set shell
     :param dice: a Dice object to change a shell for
-    :param dice_shell: DiceShell
+    :param dice_shell: Shell
     """
     _xyzinterpret_fn = xyz_interpret_map[dice_shell]
     _dice._xyz_interpret_fn = _xyzinterpret_fn