muffin-rest 4.4.3__tar.gz → 4.5.1__tar.gz

{muffin-rest-4.4.3/muffin_rest.egg-info → muffin_rest-4.5.1}/PKG-INFO

@@ -1,14 +1,16 @@
 Metadata-Version: 2.1
 Name: muffin-rest
-Version: 4.4.3
+Version: 4.5.1
 Summary: The package provides enhanced support for writing REST APIs with Muffin framework
-Author-email: Kirill Klenov <horneds@gmail.com>
-License: MIT License
-Project-URL: homepage, https://github.com/klen/muffin-rest
-Project-URL: repository, https://github.com/klen/muffin-rest
-Project-URL: changelog, https://raw.githubusercontent.com/klen/muffin-rest/master/CHANGELOG.md
+Home-page: https://github.com/klen/muffin-rest
+License: MIT
 Keywords: rest,api,muffin,asgi,asyncio,trio
+Author: Kirill Klenov
+Author-email: horneds@gmail.com
+Requires-Python: >=3.8,<4.0
 Classifier: Development Status :: 5 - Production/Stable
+Classifier: Framework :: AsyncIO
+Classifier: Framework :: Trio
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python
@@ -17,18 +19,26 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
 Classifier: Topic :: Internet :: WWW/HTTP
-Classifier: Framework :: AsyncIO
-Classifier: Framework :: Trio
-Requires-Python: >=3.8
-Description-Content-Type: text/x-rst
-Provides-Extra: tests
-Provides-Extra: dev
-Provides-Extra: yaml
-Provides-Extra: example
 Provides-Extra: peewee
 Provides-Extra: sqlalchemy
-License-File: LICENSE
+Provides-Extra: yaml
+Requires-Dist: apispec (>=4,<5)
+Requires-Dist: marshmallow (>=3.14,<4.0)
+Requires-Dist: marshmallow-peewee (>=4,<5) ; extra == "peewee"
+Requires-Dist: marshmallow-sqlalchemy (>=0.27.0,<0.28.0) ; extra == "sqlalchemy"
+Requires-Dist: muffin (>=0.94,<0.95)
+Requires-Dist: muffin-databases (>=0.5.0,<0.6.0) ; extra == "sqlalchemy"
+Requires-Dist: muffin-peewee-aio (>=0.9.6,<0.10.0) ; extra == "peewee"
+Requires-Dist: pyyaml ; extra == "yaml"
+Requires-Dist: sqlalchemy ; extra == "sqlalchemy"
+Project-URL: Repository, https://github.com/klen/muffin-rest
+Description-Content-Type: text/x-rst
 
 Muffin-REST
 ###########
@@ -173,3 +183,4 @@ Licensed under a `MIT license`_.
 .. _SqlAlchemy Core: https://docs.sqlalchemy.org/en/14/core/
 
 .. _MIT license: http://opensource.org/licenses/MIT
+

{muffin-rest-4.4.3 → muffin_rest-4.5.1}/muffin_rest/openapi.py

@@ -4,8 +4,7 @@ import re
 from contextlib import suppress
 from functools import partial
 from http import HTTPStatus
-from types import ModuleType
-from typing import Callable, Dict, List, Optional, Tuple, cast
+from typing import Callable, Dict, List, Tuple, cast
 
 from apispec import utils
 from apispec.core import APISpec
@@ -18,11 +17,11 @@ from muffin import Response
 from . import LIMIT_PARAM, OFFSET_PARAM, openapi
 from .options import RESTOptions
 
-yaml_utils: Optional[ModuleType] = None
-
 with suppress(ImportError):
     from apispec import yaml_utils
 
+locals().setdefault("yaml_utils", None)
+
 
 DEFAULT_METHODS = ("get",)
 HTTP_METHODS = [
@@ -45,7 +44,8 @@ def render_openapi(api, request):
     # Setup Specs
     options = dict(api.openapi_options)
     options.setdefault(
-        "servers", [{"url": str(request.url.with_query("").with_path(api.prefix))}],
+        "servers",
+        [{"url": str(request.url.with_query("").with_path(api.prefix))}],
     )
 
     spec = APISpec(
@@ -163,7 +163,6 @@ def return_type_to_response(fn: Callable) -> Dict:
         and issubclass(return_type, Response)
         and return_type.content_type
     ):
-
         responses[return_type.status_code] = {
             "description": HTTPStatus(return_type.status_code).description,
             "content": {return_type.content_type: {}},

{muffin-rest-4.4.3 → muffin_rest-4.5.1}/muffin_rest/peewee/__init__.py

@@ -2,8 +2,9 @@
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Optional, Tuple, Type, TypeVar, cast, overload
+from typing import TYPE_CHECKING, Optional, Tuple, Type, cast, overload
 
+import marshmallow as ma
 import peewee as pw
 from apispec.ext.marshmallow import MarshmallowPlugin
 from marshmallow_peewee import ForeignKey
@@ -14,16 +15,17 @@ from muffin_rest.handler import RESTBase
 from muffin_rest.peewee.openapi import PeeweeOpenAPIMixin
 
 from .options import PWRESTOptions
+from .schemas import EnumField
+from .types import TVModel
 
 if TYPE_CHECKING:
-    import marshmallow as ma
     from asgi_tools.types import TJSON
     from muffin import Request
 
 # XXX: Patch apispec.MarshmallowPlugin to support ForeignKeyField
 MarshmallowPlugin.Converter.field_mapping[ForeignKey] = ("integer", None)
 
-TVModel = TypeVar("TVModel", bound=pw.Model)
+assert issubclass(EnumField, ma.fields.Field)  # just register EnumField
 
 
 class PWRESTBase(RESTBase[TVModel], PeeweeOpenAPIMixin):

muffin_rest-4.5.1/muffin_rest/peewee/schemas.py

@@ -0,0 +1,36 @@
+import marshmallow as ma
+from marshmallow_peewee import DefaultConverter
+from muffin_peewee.fields import IntEnumField, StrEnumField
+
+
+class EnumField(ma.fields.Field):
+    default_error_messages = {
+        "unknown": "Must be one of: {choices}.",
+    }
+
+    def __init__(self, enum, **kwargs):
+        self.enum = enum
+        self.choices_text = ", ".join([str(c.value) for c in enum])
+        super().__init__(**kwargs)
+
+    def _serialize(self, value, attr, obj, **kwargs):
+        if value is None:
+            return None
+
+        return value.value
+
+    def _deserialize(self, value, attr, data, **kwargs):
+        try:
+            return self.enum(value)
+        except ValueError as error:
+            raise self.make_error("unknown", choices=self.choices_text) from error
+
+
+@DefaultConverter.register(StrEnumField)
+@DefaultConverter.register(IntEnumField)
+def build_field(field, opts, **params):
+    params.pop("validate", None)
+    return EnumField(field.enum, **params)
+
+
+# ruff: noqa: ARG001, ARG002

{muffin-rest-4.4.3 → muffin_rest-4.5.1}/muffin_rest/peewee/types.py

@@ -1,5 +1,6 @@
 from typing import TypeVar
 
-from peewee import Query
+from peewee import Model, Query
 
+TVModel = TypeVar("TVModel", bound=Model)
 TVCollection = TypeVar("TVCollection", bound=Query)

{muffin-rest-4.4.3 → muffin_rest-4.5.1}/pyproject.toml

@@ -1,11 +1,12 @@
-[project]
+[tool.poetry]
 name = "muffin-rest"
-version = "4.4.3"
+version = "4.5.1"
 description = "The package provides enhanced support for writing REST APIs with Muffin framework"
 readme = "README.rst"
-requires-python = ">=3.8"
-license = {"text" = "MIT License"}
-authors = [{ name = "Kirill Klenov", email = "horneds@gmail.com" }]
+homepage = "https://github.com/klen/muffin-rest"
+repository = "https://github.com/klen/muffin-rest"
+authors = ["Kirill Klenov <horneds@gmail.com>"]
+license = "MIT"
 keywords = ["rest", "api", "muffin", "asgi", "asyncio", "trio"]
 classifiers = [
   "Development Status :: 5 - Production/Stable",
@@ -21,51 +22,49 @@ classifiers = [
   "Framework :: AsyncIO",
   "Framework :: Trio",
 ]
-dependencies = [
-  "apispec >= 4",
-  "marshmallow >= 3.14",
-  "muffin >= 0.92",
-]
 
-[project.urls]
-homepage = "https://github.com/klen/muffin-rest"
-repository = "https://github.com/klen/muffin-rest"
-changelog = "https://raw.githubusercontent.com/klen/muffin-rest/master/CHANGELOG.md"
+[tool.poetry.dependencies]
+python = "^3.8"
+apispec = "^4"
+marshmallow = "^3.14"
+muffin = "^0.94"
 
-[project.optional-dependencies]
-tests = [
-  "aiosqlite",
-  "marshmallow-peewee  >= 3.2.0",
-  "marshmallow-sqlalchemy >= 0.27.0",
-  "muffin-databases    >= 0.3.2",
-  "muffin-mongo        >= 0.3.1",
-  "muffin-peewee-aio",
-  "pytest",
-  "pytest-aio[curio,trio]",
-  "pytest-mypy",
-  "pyyaml",
-  "types-PyYAML",
-  "types-ujson",
-  "ruff",
-]
-dev = ["pre-commit", "refurb", "bump2version"]
+# Optional dependencies
+pyyaml = {version = "*", optional = true}
+muffin-peewee-aio = {version = "^0.9.6", optional = true}
+marshmallow-peewee = {version = "^4", optional = true}
+muffin-databases = {version = "^0.5.0", optional = true}
+marshmallow-sqlalchemy = {version = "^0.27.0", optional = true}
+sqlalchemy = {version = "*", optional = true}
+
+[tool.poetry.extras]
 yaml = ["pyyaml"]
-example = ["uvicorn", "muffin-peewee-aio", "marshmallow-peewee"]
-peewee = [
-    "muffin-peewee-aio >= 0.2.2",
-    "marshmallow-peewee >= 3.2.0",
-]
-sqlalchemy = [
-    "muffin-databases >= 0.3.2",
-    "marshmallow-sqlalchemy",
-    "sqlalchemy",
-]
+peewee = ["muffin-peewee-aio", "marshmallow-peewee"]
+sqlalchemy = ["muffin-databases", "marshmallow-sqlalchemy", "sqlalchemy"]
 
-[tool.setuptools]
-packages = ['muffin_rest']
+[tool.poetry.group.tests.dependencies]
+aiosqlite = "*"
+marshmallow-peewee = "^4"
+marshmallow-sqlalchemy = "^0.27.0"
+muffin-databases = "^0.5.0"
+muffin-mongo = "^0.5.1"
+muffin-peewee-aio = "^0.9.6"
+pytest = "*"
+pytest-aio = {version = "*", extras = ["curio", "trio"]}
+pytest-mypy = "*"
+pyyaml = "*"
+types-PyYAML = "*"
+types-ujson = "*"
+ruff = "*"
+
+[tool.poetry.group.dev.dependencies]
+pre-commit = "*"
+
+[tool.poetry.group.example.dependencies]
+uvicorn = "*"
+muffin-peewee-aio = "^0.9.6"
+marshmallow-peewee = "^4"
 
-[tool.setuptools.package-data]
-muffin_rest = ["py.typed"]
 
 [tool.pytest.ini_options]
 addopts = "-xsv"
@@ -100,3 +99,7 @@ target-version = "py38"
 exclude = [".venv", "docs", "examples"]
 select = ["ALL"]
 ignore = ["D", "UP", "ANN", "DJ", "EM", "RSE", "SLF", "RET", "S101", "PLR2004", "PLR0912", "N804", "A003", "TRY003"]
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"

muffin-rest-4.4.3/CHANGELOG.md

@@ -1,35 +0,0 @@
-# Changelog
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [Unreleased]
-
-## [4.0.0] - 2021-11-01
-### Changed
-* Filters and sorting are async now
-
-## [3.5.1] - 2021-10-21
-### Changed
-* Minimal version for `marshmallow-peewee` now is `3.2`
-
-## [3.5.0] - 2021-10-20
-### Added
-- Support for python 3.10
-
-## [3.4.4] - 2021-09-16
-### Added
-
-### Changed
-
-### Removed
-
-
-[Unreleased]: https://github.com/klen/muffin-rest/compare/4.0.0...HEAD
-[3.5.1]: https://github.com/klen/muffin-rest/compare/3.5.1...4.0.0
-[3.5.1]: https://github.com/klen/muffin-rest/compare/3.5.0...3.5.1
-[3.5.0]: https://github.com/klen/muffin-rest/compare/3.4.4...3.5.0
-[3.4.4]: https://github.com/klen/muffin-rest/compare/0.1.0...3.4.4
-[0.1.0]: https://github.com/klen/aio-apiclient/releases/tag/0.1.0
-

muffin-rest-4.4.3/MANIFEST.in

@@ -1,11 +0,0 @@
-include CHANGELOG.md
-include LICENSE
-include MANIFEST.in
-include README.rst
-
-recursive-include muffin_rest *
-recursive-include requirements *.txt
-
-recursive-exclude * __pycache__
-recursive-exclude * *.py[co]
-recursive-exclude * *.orig

muffin-rest-4.4.3/PKG-INFO

@@ -1,175 +0,0 @@
-Metadata-Version: 2.1
-Name: muffin-rest
-Version: 4.4.3
-Summary: The package provides enhanced support for writing REST APIs with Muffin framework
-Author-email: Kirill Klenov <horneds@gmail.com>
-License: MIT License
-Project-URL: homepage, https://github.com/klen/muffin-rest
-Project-URL: repository, https://github.com/klen/muffin-rest
-Project-URL: changelog, https://raw.githubusercontent.com/klen/muffin-rest/master/CHANGELOG.md
-Keywords: rest,api,muffin,asgi,asyncio,trio
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Topic :: Internet :: WWW/HTTP
-Classifier: Framework :: AsyncIO
-Classifier: Framework :: Trio
-Requires-Python: >=3.8
-Description-Content-Type: text/x-rst
-Provides-Extra: tests
-Provides-Extra: dev
-Provides-Extra: yaml
-Provides-Extra: example
-Provides-Extra: peewee
-Provides-Extra: sqlalchemy
-License-File: LICENSE
-
-Muffin-REST
-###########
-
-.. _description:
-
-**Muffin-REST** -- provides enhanced support for writing REST APIs with Muffin_.
-
-
-.. _badges:
-
-.. image:: https://github.com/klen/muffin-rest/workflows/tests/badge.svg
-    :target: https://github.com/klen/muffin-rest/actions
-    :alt: Tests Status
-
-.. image:: https://img.shields.io/pypi/v/muffin-rest
-    :target: https://pypi.org/project/muffin-rest/
-    :alt: PYPI Version
-
-.. image:: https://img.shields.io/pypi/pyversions/muffin-rest
-    :target: https://pypi.org/project/muffin-rest/
-    :alt: Python Versions
-
-----------
-
-.. _features:
-
-Features
---------
-
-- API class to simplify the creation of REST APIs;
-- Automatic filtering and sorting for resources;
-- Support for `Peewee ORM`_, Mongo_, `SQLAlchemy Core`_;
-- Auto documentation with Swagger_;
-
-.. _contents:
-
-.. contents::
-
-.. _requirements:
-
-Requirements
-=============
-
-- python >= 3.7
-
-.. note:: Trio is only supported with Peewee ORM
-
-.. _installation:
-
-Installation
-=============
-
-**Muffin-REST** should be installed using pip: ::
-
-    pip install muffin-rest
-
-With `SQLAlchemy Core`_ support: ::
-
-    pip install muffin-rest[sqlalchemy]
-
-With `Peewee ORM`_ support: ::
-
-    pip install muffin-rest[peewee]
-
-With YAML support for autodocumentation: ::
-
-    pip install muffin-rest[yaml]
-
-.. _usage:
-
-Usage
-=====
-
-Create an API:
-
-.. code-block:: python
-
-   from muffin_rest import API
-
-   api = API()
-
-Create endpoints and connect them to the API (example for sqlalchemy):
-
-.. code-block:: python
-
-   from muffin_rest.sqlalchemy import SAEndpoint
-   from project.api import api
-
-   @api.route
-   class MyEndpoint(SAEndpoint):
-
-        class Meta:
-            table = MyTable
-            database = db
-
-Connect it to your Muffin_ application:
-
-.. code-block:: python
-
-   from project.api import api
-
-   api.setup(app, prefix='/api/v1')
-
-
-.. _bugtracker:
-
-Bug tracker
-===========
-
-If you have any suggestions, bug reports or
-annoyances please report them to the issue tracker
-at https://github.com/klen/muffin-rest/issues
-
-.. _contributing:
-
-Contributing
-============
-
-Development of Muffin-REST happens at: https://github.com/klen/muffin-rest
-
-
-Contributors
-=============
-
-* klen_ (Kirill Klenov)
-
-.. _license:
-
-License
-========
-
-Licensed under a `MIT license`_.
-
-.. _links:
-
-.. _klen: https://github.com/klen
-.. _Muffin: https://github.com/klen/muffin
-.. _Swagger: https://swagger.io/tools/swagger-ui/
-.. _Mongo: https://www.mongodb.com/
-.. _Peewee ORM: http://docs.peewee-orm.com/en/latest/
-.. _SqlAlchemy Core: https://docs.sqlalchemy.org/en/14/core/
-
-.. _MIT license: http://opensource.org/licenses/MIT

muffin-rest-4.4.3/muffin_rest.egg-info/SOURCES.txt

@@ -1,44 +0,0 @@
-CHANGELOG.md
-LICENSE
-MANIFEST.in
-README.rst
-pyproject.toml
-muffin_rest/__init__.py
-muffin_rest/api.py
-muffin_rest/errors.py
-muffin_rest/filters.py
-muffin_rest/handler.py
-muffin_rest/openapi.py
-muffin_rest/options.py
-muffin_rest/py.typed
-muffin_rest/redoc.html
-muffin_rest/sorting.py
-muffin_rest/swagger.html
-muffin_rest/types.py
-muffin_rest/utils.py
-muffin_rest.egg-info/PKG-INFO
-muffin_rest.egg-info/SOURCES.txt
-muffin_rest.egg-info/dependency_links.txt
-muffin_rest.egg-info/requires.txt
-muffin_rest.egg-info/top_level.txt
-muffin_rest/mongo/__init__.py
-muffin_rest/mongo/filters.py
-muffin_rest/mongo/schema.py
-muffin_rest/mongo/sorting.py
-muffin_rest/mongo/types.py
-muffin_rest/mongo/utils.py
-muffin_rest/peewee/__init__.py
-muffin_rest/peewee/filters.py
-muffin_rest/peewee/openapi.py
-muffin_rest/peewee/options.py
-muffin_rest/peewee/sorting.py
-muffin_rest/peewee/types.py
-muffin_rest/sqlalchemy/__init__.py
-muffin_rest/sqlalchemy/filters.py
-muffin_rest/sqlalchemy/sorting.py
-muffin_rest/sqlalchemy/types.py
-tests/test_base.py
-tests/test_mongo.py
-tests/test_openapi.py
-tests/test_peewee.py
-tests/test_sqlalchemy.py

muffin-rest-4.4.3/muffin_rest.egg-info/dependency_links.txt

@@ -1 +0,0 @@
-

muffin-rest-4.4.3/muffin_rest.egg-info/requires.txt

@@ -1,40 +0,0 @@
-apispec>=4
-marshmallow>=3.14
-muffin>=0.92
-
-[dev]
-pre-commit
-refurb
-bump2version
-
-[example]
-uvicorn
-muffin-peewee-aio
-marshmallow-peewee
-
-[peewee]
-muffin-peewee-aio>=0.2.2
-marshmallow-peewee>=3.2.0
-
-[sqlalchemy]
-muffin-databases>=0.3.2
-marshmallow-sqlalchemy
-sqlalchemy
-
-[tests]
-aiosqlite
-marshmallow-peewee>=3.2.0
-marshmallow-sqlalchemy>=0.27.0
-muffin-databases>=0.3.2
-muffin-mongo>=0.3.1
-muffin-peewee-aio
-pytest
-pytest-aio[curio,trio]
-pytest-mypy
-pyyaml
-types-PyYAML
-types-ujson
-ruff
-
-[yaml]
-pyyaml

muffin-rest-4.4.3/muffin_rest.egg-info/top_level.txt

@@ -1 +0,0 @@
-muffin_rest

muffin-rest-4.4.3/setup.cfg

@@ -1,4 +0,0 @@
-[egg_info]
-tag_build = 
-tag_date = 0
-