Merge pull request #88 from the-dotify-project/development

Development

Author: billsioros

.github/workflows/ci.yml

@@ -47,42 +47,3 @@ jobs:
           SPOTIFY_ID: ${{ secrets.SPOTIFY_ID }}
           SPOTIFY_SECRET: ${{ secrets.SPOTIFY_SECRET }}
         run: poetry run python -m tox
-
-  docs:
-    runs-on: ${{ matrix.platform }}
-    strategy:
-      matrix:
-        platform: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: [3.7, 3.8, 3.9]
-    steps:
-      - uses: actions/checkout@v2
-
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
-        with:
-          python-version: ${{ matrix.python-version }}
-
-      - name: Install Poetry
-        uses: abatilo/[email protected]
-        with:
-          poetry-version: 1.1.6
-
-      - name: Configure Poetry
-        run: |
-          poetry config virtualenvs.in-project true
-
-      - name: Set up cache
-        uses: actions/[email protected]
-        with:
-          path: |
-            .tox
-            .venv
-          key: ${{ matrix.platform }}-tox-venv-${{ matrix.python-version }}-${{ hashFiles('**/poetry.lock') }}
-
-      - name: Install dependencies
-        run: |
-          poetry install
-
-      - name: Run MkDocs
-        run: |
-          poetry run python -m mkdocs build

.pre-commit-config.yaml

@@ -54,3 +54,7 @@ repos:
     rev: v2.3
     hooks:
       - id: vulture
+  - repo: https://github.com/tox-dev/tox-ini-fmt
+    rev: 0.5.1
+    hooks:
+      - id: tox-ini-fmt

README.md

@@ -98,7 +98,7 @@ pip install dotify
 
 ## Contributing
 
-If you would like to contribute to the project, please go through the [Contributing Guidelines](https://the-dotify-project.github.io/dotify/CONTRIBUTING/) first.
+If you would like to contribute to the project, please go through the [Contributing Guidelines](https://the-dotify-project.github.io/dotify/latest/CONTRIBUTING/) first.
 
 ## Contributors ✨
 

docs/CONTRIBUTING.md

@@ -36,7 +36,7 @@ PRs can be a quick way to get your fix or improvement slated for the next releas
 - Be accompanied by a complete Pull Request template (loaded automatically when a PR is created).
 - Add [unit or integration tests](https://github.com/the-dotify-project/dotify/tree/master/examples) for added or changed functionality.
 - Any code related changes should be accompanied by corresponding changes to the project's documentation.
-- If your pull request introduces a new feature, the corresponding `README` [section](https://the-dotify-project.github.io/dotify/#features) must be updated to reflect this. Make sure you also include [an example](https://github.com/the-dotify-project/dotify/tree/master/examples), showcasing this new functionality.
+- If your pull request introduces a new feature, the corresponding `README` [section](https://the-dotify-project.github.io/dotify/latest/#features) must be updated to reflect this. Make sure you also include [an example](https://github.com/the-dotify-project/dotify/tree/master/examples), showcasing this new functionality.
 - Write clear, concise commit message(s) using [conventional-changelog format](https://github.com/conventional-changelog/conventional-changelog-angular/blob/master/convention.md). [Why?](#writing-your-commit-message)
 - If your PR is connected to an open issue, add a line in your PR's description that says `Fixes: #123`, where `#123` is the number of the issue you're fixing.
 

dotify/_json_serializable.py

@@ -1,8 +1,7 @@
 import json
 import logging
 from abc import ABCMeta
-from os import PathLike
-from typing import Any, Dict, Optional
+from typing import Any, Optional
 
 from python_jsonschema_objects import ObjectBuilder
 from python_jsonschema_objects.classbuilder import LiteralValue, ProtocolBase
@@ -44,17 +43,15 @@ def __new__(cls, name, bases, attrs):  # noqa: D102
 class JsonSerializable(ProtocolBase, metaclass=JsonSerializableMeta):
     """A class providing JSON serialization and de-serialization."""
 
-    class Json(object):
-        schema: PathLike
-        dependencies: Dict[str, "JsonSerializable"]
-
     def __setattr__(self, name: str, val: Any) -> None:
         try:
             super().__setattr__(name, val)
         except ValidationError:
             if name in self.__annotations__:
                 self.__dict__[name] = val
 
+                return
+
             raise
 
     def __getattribute__(self, name: str) -> Any:

dotify/_model.py

@@ -26,14 +26,24 @@ class ModelMeta(JsonSerializableMeta):
     """
 
     def __new__(cls, name, bases, attrs):  # noqa: D102
-        if "Json" in attrs:
-            attrs["Json"].schema = cls._dependency_path(name)
+        json_meta = type("Json", (object,), {})
+        with contextlib.suppress(KeyError):
+            json_meta = attrs["Json"]
+
+        is_abstract = False
+        with contextlib.suppress(AttributeError):
+            is_abstract = json_meta.abstract
+
+        if not is_abstract:
+            json_meta.schema = cls._dependency_path(name)
 
             with contextlib.suppress(AttributeError):
-                attrs["Json"].dependencies = cls._dependencies_from(
-                    attrs["Json"].dependencies,
+                json_meta.dependencies = cls._dependencies_from(
+                    json_meta.dependencies,
                 )
 
+        attrs["Json"] = json_meta
+
         return super().__new__(cls, name, bases, attrs)
 
     @classmethod
@@ -91,6 +101,9 @@ def decorator(_):
 class Model(JsonSerializable, metaclass=ModelMeta):
     """The base class for every Spotify Web API entity."""
 
+    class Json(object):
+        abstract = True
+
     class UnexpectedError(Exception):
         """An exception indicating an unexpected error."""
 

dotify/models/_album.py

@@ -21,6 +21,9 @@
 class AlbumBase(Model):
     """`AlbumBase` defines the interface of the Album class, which is subclassing it."""
 
+    class Json(object):
+        abstract = True
+
     def __str__(self):
         return "{0} - {1}".format(self.artist, self.name)
 

dotify/models/_artist.py

@@ -9,9 +9,6 @@
 class Artist(Model):
     """A class representing a Spotify `Artist`."""
 
-    class Json(object):
-        """ """
-
     @property
     def url(self) -> AnyStr:
         """Return the artist's Spotify URL.

dotify/models/_image.py

@@ -8,8 +8,5 @@
 class Image(Model):
     """A class representing a Spotify `Image`."""
 
-    class Json(object):
-        """ """
-
     def __str__(self):
         return self.url

dotify/models/_playlist.py

@@ -14,6 +14,9 @@
 class PlaylistBase(Model):
     """`PlaylistBase` defines the interface of the Playlist class, which is subclassing it."""
 
+    class Json(object):
+        abstract = True
+
     def __init__(self, **props) -> None:  # noqa: D107
         props.pop("tracks", None)