Merge pull request #161 from arnauddupuis/arnauddupuis/issue123

arnauddupuis/issue123
pygamelib · Jun 15, 2021 · 967b55b · 967b55b
2 parents d7cfeda + 44da2aa
commit 967b55b
Show file tree

Hide file tree

Showing 44 changed files with 1,076 additions and 229 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -3,25 +3,25 @@ jobs:
   build:
     working_directory: ~/pygamelib
     docker:
-      - image: circleci/python:3.7
+      - image: circleci/python:3.9
         environment:
           PIPENV_VENV_IN_PROJECT: true
     steps:
       - checkout
       - run: sudo chown -R circleci:circleci /usr/local/bin
-      - run: sudo chown -R circleci:circleci /usr/local/lib/python3.7/site-packages
+      - run: sudo chown -R circleci:circleci /usr/local/lib/python3.9/site-packages
       - restore_cache:
-          key: deps10-{{ .Branch }}-{{ checksum "Pipfile.lock" }}
+          key: python39-{{ .Branch }}-{{ checksum "Pipfile.lock" }}
       - run:
           command: |
             sudo pip3 install pipenv
             pipenv install --dev
       - save_cache:
-          key: deps10-{{ .Branch }}-{{ checksum "Pipfile.lock" }}
+          key: python39-{{ .Branch }}-{{ checksum "Pipfile.lock" }}
           paths:
             - ".venv"
             - "/usr/local/bin"
-            - "/usr/local/lib/python3.7/site-packages"
+            - "/usr/local/lib/python3.9/site-packages"
       - run:
           name: Run linting and metrics
           command: |

diff --git a/.legacy/requirements.txt b/.legacy/requirements.txt
@@ -6,3 +6,4 @@ numpy==1.19.2
 readchar==2.0.1
 six==1.16.0
 wcwidth==0.2.5
+importlib_resources==5.1.3
diff --git a/Pipfile b/Pipfile
@@ -17,5 +17,6 @@ colorama = ">=0.3.8"
 readchar = ">=2.0.0"
 appdirs = ">=1.4.4"
 blessed = ">=1.17.0"
+importlib_resources = ">=5.1.3"
 numpy = "*"
 # Please update the .legacy/requirements.txt with new dependencies added here.
diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/docs/generated/pygamelib.base.Console.rst b/docs/generated/pygamelib.base.Console.rst
@@ -0,0 +1,23 @@
+pygamelib.base.Console
+======================
+
+.. currentmodule:: pygamelib.base
+
+.. autoclass:: Console
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~Console.__init__
+      ~Console.instance
+
+
+
+
+
+
diff --git a/docs/generated/pygamelib.base.Math.rst b/docs/generated/pygamelib.base.Math.rst
@@ -0,0 +1,24 @@
+pygamelib.base.Math
+===================
+
+.. currentmodule:: pygamelib.base
+
+.. autoclass:: Math
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~Math.__init__
+      ~Math.distance
+      ~Math.intersect
+
+
+
+
+
+
diff --git a/docs/generated/pygamelib.base.PglBaseObject.rst b/docs/generated/pygamelib.base.PglBaseObject.rst
@@ -0,0 +1,26 @@
+pygamelib.base.PglBaseObject
+============================
+
+.. currentmodule:: pygamelib.base
+
+.. autoclass:: PglBaseObject
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~PglBaseObject.__init__
+      ~PglBaseObject.attach
+      ~PglBaseObject.be_notified
+      ~PglBaseObject.detach
+      ~PglBaseObject.notify
+
+
+
+
+
+
diff --git a/docs/generated/pygamelib.base.PglException.rst b/docs/generated/pygamelib.base.PglException.rst
@@ -0,0 +1,6 @@
+pygamelib.base.PglException
+===========================
+
+.. currentmodule:: pygamelib.base
+
+.. autoexception:: PglException
diff --git a/docs/generated/pygamelib.base.PglInvalidLevelException.rst b/docs/generated/pygamelib.base.PglInvalidLevelException.rst
@@ -0,0 +1,6 @@
+pygamelib.base.PglInvalidLevelException
+=======================================
+
+.. currentmodule:: pygamelib.base
+
+.. autoexception:: PglInvalidLevelException
diff --git a/docs/generated/pygamelib.base.PglInvalidTypeException.rst b/docs/generated/pygamelib.base.PglInvalidTypeException.rst
@@ -0,0 +1,6 @@
+pygamelib.base.PglInvalidTypeException
+======================================
+
+.. currentmodule:: pygamelib.base
+
+.. autoexception:: PglInvalidTypeException
diff --git a/docs/generated/pygamelib.base.PglObjectIsNotMovableException.rst b/docs/generated/pygamelib.base.PglObjectIsNotMovableException.rst
@@ -0,0 +1,6 @@
+pygamelib.base.PglObjectIsNotMovableException
+=============================================
+
+.. currentmodule:: pygamelib.base
+
+.. autoexception:: PglObjectIsNotMovableException
diff --git a/docs/generated/pygamelib.base.PglOutOfBoardBoundException.rst b/docs/generated/pygamelib.base.PglOutOfBoardBoundException.rst
@@ -0,0 +1,6 @@
+pygamelib.base.PglOutOfBoardBoundException
+==========================================
+
+.. currentmodule:: pygamelib.base
+
+.. autoexception:: PglOutOfBoardBoundException
diff --git a/docs/generated/pygamelib.base.Text.rst b/docs/generated/pygamelib.base.Text.rst
@@ -0,0 +1,65 @@
+pygamelib.base.Text
+===================
+
+.. currentmodule:: pygamelib.base
+
+.. autoclass:: Text
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~Text.__init__
+      ~Text.attach
+      ~Text.be_notified
+      ~Text.black
+      ~Text.black_bright
+      ~Text.black_dim
+      ~Text.blue
+      ~Text.blue_bright
+      ~Text.blue_dim
+      ~Text.cyan
+      ~Text.cyan_bright
+      ~Text.cyan_dim
+      ~Text.debug
+      ~Text.detach
+      ~Text.fatal
+      ~Text.green
+      ~Text.green_bright
+      ~Text.green_dim
+      ~Text.info
+      ~Text.magenta
+      ~Text.magenta_bright
+      ~Text.magenta_dim
+      ~Text.notify
+      ~Text.print_white_on_red
+      ~Text.red
+      ~Text.red_bright
+      ~Text.red_dim
+      ~Text.render_to_buffer
+      ~Text.warn
+      ~Text.white
+      ~Text.white_bright
+      ~Text.white_dim
+      ~Text.yellow
+      ~Text.yellow_bright
+      ~Text.yellow_dim
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~Text.bg_color
+      ~Text.fg_color
+      ~Text.length
+      ~Text.text
+
+
diff --git a/docs/generated/pygamelib.base.Vector2D.rst b/docs/generated/pygamelib.base.Vector2D.rst
@@ -0,0 +1,34 @@
+pygamelib.base.Vector2D
+=======================
+
+.. currentmodule:: pygamelib.base
+
+.. autoclass:: Vector2D
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~Vector2D.__init__
+      ~Vector2D.from_direction
+      ~Vector2D.length
+      ~Vector2D.unit
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~Vector2D.column
+      ~Vector2D.row
+      ~Vector2D.x
+      ~Vector2D.y
+
+
diff --git a/docs/source/base.rst b/docs/source/base.rst
@@ -3,10 +3,21 @@
 base
 ====
 
-.. automodule:: pygamelib.base
-    :members:
-    :inherited-members:
-    :undoc-members:
-    :show-inheritance:
+The base module provide basic objects and exceptions that are used by the entire library.
+
+.. toctree::
+
+   pygamelib.base.Math.rst
+   pygamelib.base.PglBaseObject.rst
+   pygamelib.base.PglException.rst
+   pygamelib.base.PglInvalidLevelException.rst
+   pygamelib.base.PglInvalidTypeException.rst
+   pygamelib.base.PglObjectIsNotMovableException.rst
+   pygamelib.base.PglOutOfBoardBoundException.rst
+   pygamelib.base.Text.rst
+   pygamelib.base.Vector2D.rst
+   base_deprecated
 
-.. autoattribute:: pygamelib.base.Text
+
+.. automodule:: pygamelib.base
+    :noindex:
diff --git a/docs/source/base_deprecated.rst b/docs/source/base_deprecated.rst
@@ -0,0 +1,18 @@
+.. _base_deprecated-module:
+
+base (deprecated)
+=================
+
+These are the deprecated objects of the pygamelib.base module. They should not be used
+as they are going to be removed in future versions.
+
+.. toctree::
+
+   pygamelib.base.HacException.rst
+   pygamelib.base.HacInvalidLevelException.rst
+   pygamelib.base.HacInvalidTypeException.rst
+   pygamelib.base.HacObjectIsNotMovableException.rst
+   pygamelib.base.HacOutOfBoardBoundException.rst
+
+.. automodule:: pygamelib.base
+    :noindex:
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -24,7 +24,7 @@
 # -- Project information -----------------------------------------------------
 
 project = "pygamelib"
-copyright = "2019-2020, Arnaud Dupuis"
+copyright = "2019-2021, Arnaud Dupuis"
 author = "Arnaud Dupuis"
 
 # The short X.Y version

diff --git a/docs/source/pygamelib.base.HacException.rst b/docs/source/pygamelib.base.HacException.rst
@@ -1,7 +1,6 @@
-:orphan:
 
-pygamelib.base.HacException
-===========================
+HacException
+============
 
 .. currentmodule:: pygamelib.base
 

diff --git a/docs/source/pygamelib.base.HacInvalidLevelException.rst b/docs/source/pygamelib.base.HacInvalidLevelException.rst
@@ -1,7 +1,6 @@
-:orphan:
 
-pygamelib.base.HacInvalidLevelException
-=======================================
+HacInvalidLevelException
+========================
 
 .. currentmodule:: pygamelib.base
 

diff --git a/docs/source/pygamelib.base.HacInvalidTypeException.rst b/docs/source/pygamelib.base.HacInvalidTypeException.rst
@@ -1,7 +1,6 @@
-:orphan:
 
-pygamelib.base.HacInvalidTypeException
-======================================
+HacInvalidTypeException
+=======================
 
 .. currentmodule:: pygamelib.base
 

diff --git a/docs/source/pygamelib.base.HacObjectIsNotMovableException.rst b/docs/source/pygamelib.base.HacObjectIsNotMovableException.rst
@@ -1,7 +1,6 @@
-:orphan:
 
-pygamelib.base.HacObjectIsNotMovableException
-=============================================
+HacObjectIsNotMovableException
+==============================
 
 .. currentmodule:: pygamelib.base
 

diff --git a/docs/source/pygamelib.base.HacOutOfBoardBoundException.rst b/docs/source/pygamelib.base.HacOutOfBoardBoundException.rst
@@ -1,7 +1,6 @@
-:orphan:
 
-pygamelib.base.HacOutOfBoardBoundException
-==========================================
+HacOutOfBoardBoundException
+===========================
 
 .. currentmodule:: pygamelib.base
 

diff --git a/docs/source/pygamelib.base.Math.rst b/docs/source/pygamelib.base.Math.rst
@@ -1,9 +1,13 @@
-pygamelib.base.Math
-===================
+Math
+====
 
 .. currentmodule:: pygamelib.base
 
 .. autoclass:: Math
+   :members:
+   :inherited-members:
+   :undoc-members:
+   :show-inheritance:
 
 
    .. automethod:: __init__