panther 1.7.1__tar.gz → 1.7.3__tar.gz

{panther-1.7.1 → panther-1.7.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: panther
-Version: 1.7.1
+Version: 1.7.3
 Summary: Fast &  Friendly, Web Framework For Building Async APIs
 Home-page: https://github.com/alirn76/panther
 Author: Ali RajabNezhad
@@ -14,23 +14,27 @@ Description-Content-Type: text/markdown
 Provides-Extra: full
 License-File: LICENSE
 
-
 ## Panther 
 <b>Is A Fast &  Friendly, Web Framework For Building Async APIs With Python 3.11+</b> 
 
+<p align="center">
+<img src="https://github.com/AliRn76/panther/raw/master/docs/docs/images/logo.png" alt="logo" style="width: 200px">
+</p>
+
 >_Full Documentation_ -> [https://pantherpy.github.io](https://pantherpy.github.io)
 > 
 >_PyPI_ -> [https://pypi.org/project/panther/](https://pypi.org/project/panther/)
 
 ---
 
-### Features
+### Why Use Panther ?
 - Document-oriented Databases ODM ([PantherDB](https://pypi.org/project/pantherdb/), MongoDB)
 - Visual API Monitoring (In Terminal)
-- Cache APIs (In Memory, In Redis)
+- Caching for APIs (In Memory, In Redis)
 - Built-in Authentication Classes (Customizable)
 - Built-in Permission Classes (Customizable)
 - Handle Custom Middlewares
+- Handle Custom Throttling 
 ---
 
 ### Benchmark
@@ -150,13 +154,14 @@ with [https://github.com/nakabonne/ali](https://github.com/nakabonne/ali) and he
     **app/apis.py**:
     
     ```python
-    from datetime import datetime
+    from datetime import datetime, timedelta
 
     from panther.app import API
     from panther.configs import config
     from panther import version, status
     from panther.request import Request
     from panther.response import Response
+    from panther.throttling import Throttling
     
     
     @API()
@@ -164,7 +169,7 @@ with [https://github.com/nakabonne/ali](https://github.com/nakabonne/ali) and he
         return {'detail': 'Hello World'}
     
     
-    @API(cache=True)
+    @API(cache=True, throttling=Throttling(rate=5, duration=timedelta(minutes=1)))
     async def info(request: Request):
         data = {
             'version': version(),

{panther-1.7.1 → panther-1.7.3}/README.md

@@ -1,20 +1,24 @@
-
 ## Panther 
 <b>Is A Fast &  Friendly, Web Framework For Building Async APIs With Python 3.11+</b> 
 
+<p align="center">
+<img src="https://github.com/AliRn76/panther/raw/master/docs/docs/images/logo.png" alt="logo" style="width: 200px">
+</p>
+
 >_Full Documentation_ -> [https://pantherpy.github.io](https://pantherpy.github.io)
 > 
 >_PyPI_ -> [https://pypi.org/project/panther/](https://pypi.org/project/panther/)
 
 ---
 
-### Features
+### Why Use Panther ?
 - Document-oriented Databases ODM ([PantherDB](https://pypi.org/project/pantherdb/), MongoDB)
 - Visual API Monitoring (In Terminal)
-- Cache APIs (In Memory, In Redis)
+- Caching for APIs (In Memory, In Redis)
 - Built-in Authentication Classes (Customizable)
 - Built-in Permission Classes (Customizable)
 - Handle Custom Middlewares
+- Handle Custom Throttling 
 ---
 
 ### Benchmark
@@ -134,13 +138,14 @@ with [https://github.com/nakabonne/ali](https://github.com/nakabonne/ali) and he
     **app/apis.py**:
     
     ```python
-    from datetime import datetime
+    from datetime import datetime, timedelta
 
     from panther.app import API
     from panther.configs import config
     from panther import version, status
     from panther.request import Request
     from panther.response import Response
+    from panther.throttling import Throttling
     
     
     @API()
@@ -148,7 +153,7 @@ with [https://github.com/nakabonne/ali](https://github.com/nakabonne/ali) and he
         return {'detail': 'Hello World'}
     
     
-    @API(cache=True)
+    @API(cache=True, throttling=Throttling(rate=5, duration=timedelta(minutes=1)))
     async def info(request: Request):
         data = {
             'version': version(),

{panther-1.7.1 → panther-1.7.3}/panther/__init__.py

@@ -1,6 +1,6 @@
 from .main import Panther
 
-__version__ = '1.7.1'
+__version__ = '1.7.3'
 
 
 def version():

{panther-1.7.1 → panther-1.7.3}/panther/app.py

@@ -41,44 +41,44 @@ class API:
         async def wrapper(*args, **kwargs):
             self.request: Request = kwargs.pop('request')  # NOQA: Non-self attribute could not be type hinted
 
-            # Handle Authentication
+            # 1. Authentication
             self.handle_authentications()
 
-            # Handle Throttling
+            # 2. Throttling
             self.handle_throttling()
 
-            # Handle Authentication
+            # 3. Permissions
             self.handle_permissions()
 
-            # Validate Input
+            # 4. Validate Input
             self.validate_input()
 
-            # Validate Path Variables
+            # 5. Validate Path Variables
             self.validate_path_variables(func, kwargs)
 
-            # Get Cached Response
+            # 6. Get Cached Response
             if self.cache and self.request.method == 'GET':
                 if cached := get_cached_response_data(request=self.request):
                     return Response(data=cached.data, status_code=cached.status_code)
 
-            # Put Request In kwargs
+            # 7. Put Request In kwargs
             if req_arg := [k for k, v in func.__annotations__.items() if v == Request]:
                 kwargs[req_arg[0]] = self.request
 
-            # Call Endpoint
+            # 8. Call Endpoint
             response = await func(**kwargs)
 
-            # Clean Output
+            # 9. Clean Output
             if not isinstance(response, Response):
                 response = Response(data=response)
             data = self.serialize_response_data(data=response._data)  # NOQA: Access to a protected member
             response.set_data(data)
 
-            # Set New Response To Cache
+            # 10. Set New Response To Cache
             if self.cache and self.request.method == 'GET':
                 set_cache_response(request=self.request, response=response, cache_exp_time=self.cache_exp_time)
 
-            # Warning CacheExpTime
+            # 11. Warning CacheExpTime
             if self.cache_exp_time and self.cache is False:
                 logger.warning('"cache_exp_time" won\'t work while "cache" is False')
 

panther-1.7.3/panther/cli/monitor_command.py

@@ -0,0 +1,58 @@
+import os
+from collections import deque
+
+from rich.console import Group
+from rich.layout import Layout
+from rich.align import Align
+from rich.panel import Panel
+from rich.table import Table
+from watchfiles import watch
+from rich.live import Live
+from rich import box
+
+
+def monitor() -> None:
+    monitoring_log_file = 'logs/monitoring.log'
+
+    def _generate_table(rows: deque):
+        layout = Layout()
+
+        rows = list(rows)
+        _, lines = os.get_terminal_size()
+
+        table = Table(box=box.MINIMAL_DOUBLE_HEAD)
+        table.add_column('Datetime', justify='center', style='magenta', no_wrap=True)
+        table.add_column('Method', justify='center', style='cyan')
+        table.add_column('Path', justify='center', style='cyan')
+        table.add_column('Client', justify='center', style='cyan')
+        table.add_column('Response Time', justify='center', style='blue')
+        table.add_column('Status Code', justify='center', style='blue')
+
+        for row in rows[-lines:]:  # It will give us "lines" last lines of "rows"
+            table.add_row(*row)
+        layout.update(table)
+
+        return Panel(
+            Align.center(Group(table)),
+            box=box.ROUNDED,
+            padding=(1, 2),
+            title='Monitoring',
+            border_style='bright_blue',
+        )
+
+    with open(monitoring_log_file) as f:
+        f.readlines()  # Set cursor at the end of file
+
+        _, init_lines_count = os.get_terminal_size()
+        messages = deque(maxlen=init_lines_count - 10)  # Save space for header and footer
+
+        with Live(_generate_table(messages), auto_refresh=False, vertical_overflow='visible', screen=True) as live:
+            try:
+                for _ in watch(monitoring_log_file):
+                    data = f.readline().split('|')
+                    # 2023-03-24 01:42:52 | GET | /user/317/ | 127.0.0.1:48856 |  0.0366 ms | 200
+                    messages.append(data)
+                    live.update(_generate_table(messages))
+                    live.refresh()
+            except KeyboardInterrupt:
+                pass

{panther-1.7.1 → panther-1.7.3}/panther/cli/template.py

@@ -10,15 +10,16 @@ from panther.configs import config
 from panther import version, status
 from panther.request import Request
 from panther.response import Response
+from app.throttling import InfoThrottling
 
 
 @API()
-async def hello_world():
+async def hello_world_api():
     return {'detail': 'Hello World'}
 
 
-@API(cache=True)
-async def info(request: Request):
+@API(cache=True, throttling=InfoThrottling)
+async def info_api(request: Request):
     data = {
         'version': version(),
         'datetime_now': datetime.now().isoformat(),
@@ -34,11 +35,18 @@ models_py = """from panther.db import Model
 serializers_py = """from pydantic import BaseModel as Serializer
 """
 
-app_urls_py = """from app.apis import hello_world, info
+throttling_py = """from datetime import timedelta
+from panther.throttling import Throttling
+
+
+InfoThrottling = Throttling(rate=5, duration=timedelta(minutes=1))
+"""
+
+app_urls_py = """from app.apis import hello_world_api, info_api
 
 urls = {
-    '': hello_world,
-    'info/': info,
+    '': hello_world_api,
+    'info/': info_api,
 }
 """
 
@@ -56,23 +64,29 @@ env = load_env(BASE_DIR / '.env')
 DB_NAME = env['DB_NAME']
 SECRET_KEY = env['SECRET_KEY']
 
-
+# # # More Info: Https://PantherPy.GitHub.io/middlewares/
 MIDDLEWARES = [
     ('panther.middlewares.db.Middleware', {'url': f'pantherdb://{BASE_DIR}/{DB_NAME}.pantherdb'}),
 ]
 
 USER_MODEL = 'panther.db.models.User'
 
+# # # More Info: Https://PantherPy.GitHub.io/authentications/
+AUTHENTICATION = 'panther.authentications.JWTAuthentication'
+
+# # # More Info: Https://PantherPy.GitHub.io/monitoring/
 MONITORING = True
 
+# # # More Info: Https://PantherPy.GitHub.io/log_queries/
 LOG_QUERIES = True
 
+# # # More Info: Https://PantherPy.GitHub.io/throttling/
+THROTTLING = Throttling(rate=60, duration=timedelta(minutes=1))
+
+# # # More Info: Https://PantherPy.GitHub.io/urls/
 URLs = 'core/urls.py'
 """ % datetime.now().date().isoformat()
 
-middlewares = """from panther.middlewares import BaseMiddleware
-"""
-
 env = """
 SECRET_KEY = '%s'
 
@@ -94,8 +108,9 @@ urls = {
 git_ignore = """__pycache__/
 .venv/
 .idea/
-.env
 logs/
+
+.env
 *.pantherdb
 """
 
@@ -107,11 +122,11 @@ Template = {
         'apis.py': apis_py,
         'models.py': models_py,
         'serializers.py': serializers_py,
+        'throttling.py': throttling_py,
         'urls.py': app_urls_py,
     },
     'core': {
         'configs.py': configs_py,
-        'middlewares.py': middlewares,
         'urls.py': urls_py,
     },
     'main.py': main_py,

{panther-1.7.1 → panther-1.7.3}/panther/db/utils.py

@@ -26,7 +26,7 @@ def clean_object_id(_id: bson.ObjectId | str) -> bson.ObjectId:
     try:
         return bson.ObjectId(_id)
     except Exception:
-        raise bson.errors.InvalidId
+        raise bson.errors.InvalidId  # NOQA: Py Unresolved References
 
 
 def clean_object_id_in_dicts(*args):

{panther-1.7.1 → panther-1.7.3}/panther/main.py

@@ -180,11 +180,10 @@ class Panther:
             if path.find('panther.middlewares.db.Middleware') != -1:
                 config['db_engine'] = data['url'].split(':')[0]
 
-            # noinspection PyPep8Naming
-            Middleware = import_class(path)
+            Middleware = import_class(path)  # NOQA: Py Pep8 Naming
             if not issubclass(Middleware, BaseMiddleware):
                 logger.critical(f'{Middleware} is not a sub class of BaseMiddleware.')
                 continue
-            # noinspection PyArgumentList
-            middlewares.append(Middleware(**data))
+
+            middlewares.append(Middleware(**data))  # NOQA: Py Argument List
         return middlewares

{panther-1.7.1 → panther-1.7.3}/panther/middlewares/redis.py

@@ -20,17 +20,9 @@ class Middleware(BaseMiddleware):
             self.kwargs['host'] = '127.0.0.1'
 
     def validate_port(self):
-        if port := self.kwargs.get('port'):
-            if isinstance(port, str):
-                try:
-                    self.kwargs['port'] = int(port)
-                except ValueError:
-                    logger.critical('Redis "port" should be number')
-
-            elif not isinstance(port, int):
-                logger.critical('Redis "port" is not valid.')
-        else:
-            self.kwargs['port'] = 6379
+        port = self.kwargs.setdefault('port', 6379)
+        if not isinstance(port, int):
+            logger.critical('Redis "port" is not valid.')
 
     async def before(self, request: Request) -> Request:
         self.redis = RedisConnection(**self.kwargs)

{panther-1.7.1 → panther-1.7.3}/panther.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: panther
-Version: 1.7.1
+Version: 1.7.3
 Summary: Fast &  Friendly, Web Framework For Building Async APIs
 Home-page: https://github.com/alirn76/panther
 Author: Ali RajabNezhad
@@ -14,23 +14,27 @@ Description-Content-Type: text/markdown
 Provides-Extra: full
 License-File: LICENSE
 
-
 ## Panther 
 <b>Is A Fast &  Friendly, Web Framework For Building Async APIs With Python 3.11+</b> 
 
+<p align="center">
+<img src="https://github.com/AliRn76/panther/raw/master/docs/docs/images/logo.png" alt="logo" style="width: 200px">
+</p>
+
 >_Full Documentation_ -> [https://pantherpy.github.io](https://pantherpy.github.io)
 > 
 >_PyPI_ -> [https://pypi.org/project/panther/](https://pypi.org/project/panther/)
 
 ---
 
-### Features
+### Why Use Panther ?
 - Document-oriented Databases ODM ([PantherDB](https://pypi.org/project/pantherdb/), MongoDB)
 - Visual API Monitoring (In Terminal)
-- Cache APIs (In Memory, In Redis)
+- Caching for APIs (In Memory, In Redis)
 - Built-in Authentication Classes (Customizable)
 - Built-in Permission Classes (Customizable)
 - Handle Custom Middlewares
+- Handle Custom Throttling 
 ---
 
 ### Benchmark
@@ -150,13 +154,14 @@ with [https://github.com/nakabonne/ali](https://github.com/nakabonne/ali) and he
     **app/apis.py**:
     
     ```python
-    from datetime import datetime
+    from datetime import datetime, timedelta
 
     from panther.app import API
     from panther.configs import config
     from panther import version, status
     from panther.request import Request
     from panther.response import Response
+    from panther.throttling import Throttling
     
     
     @API()
@@ -164,7 +169,7 @@ with [https://github.com/nakabonne/ali](https://github.com/nakabonne/ali) and he
         return {'detail': 'Hello World'}
     
     
-    @API(cache=True)
+    @API(cache=True, throttling=Throttling(rate=5, duration=timedelta(minutes=1)))
     async def info(request: Request):
         data = {
             'version': version(),

panther-1.7.3/panther.egg-info/requires.txt

@@ -0,0 +1,14 @@
+bpython>=0.24
+bson>=0.5.10
+httptools>=0.5.0
+pantherdb>=1.2.2
+pydantic>=1.10.7
+redis>=4.5.3
+rich>=13.3.2
+uvicorn>=0.21.1
+uvloop>=0.17.0
+watchfiles>=0.18.1
+
+[full]
+python-jose>=3.3.0
+pymongo>=4.3.3

{panther-1.7.1 → panther-1.7.3}/setup.py

@@ -43,14 +43,16 @@ setup(
         'panther': ['cli/*'],
     },
     install_requires=[
-        'pantherdb>=1.2.0',
-        'pydantic>=1.10.5',
-        'watchfiles>=0.18.1',
-        'uvicorn[standard]',
         'bpython>=0.24',
         'bson>=0.5.10',
-        'redis>=4.0.2',
-        'rich>=13.3.1',
+        'httptools>=0.5.0',
+        'pantherdb>=1.2.2',
+        'pydantic>=1.10.7',
+        'redis>=4.5.3',
+        'rich>=13.3.2',
+        'uvicorn>=0.21.1',
+        'uvloop>=0.17.0',
+        'watchfiles>=0.18.1',
     ],
     extras_require=EXTRAS_REQUIRE,
 )

panther-1.7.1/panther/cli/monitor_command.py

@@ -1,69 +0,0 @@
-import os
-from collections import deque
-
-from rich import box
-from rich.align import Align
-from rich.console import Console, Group
-from rich.layout import Layout
-from rich.live import Live
-from rich.panel import Panel
-from rich.table import Table
-from watchfiles import watch
-
-from panther.cli.utils import cli_error
-
-
-def monitor() -> None:
-    def _generate_table(rows):
-        layout = Layout()
-        console = Console()
-
-        rows = list(rows)
-        n_rows = os.get_terminal_size()[1]
-
-        while n_rows >= 0:
-            table = Table(box=box.MINIMAL_DOUBLE_HEAD)
-            table.add_column('Datetime', justify='center', style='magenta', no_wrap=True)
-            table.add_column('Method', justify='center', style='cyan')
-            table.add_column('Path', justify='center', style='cyan')
-            table.add_column('Client', justify='center', style='cyan')
-            table.add_column('Response Time', justify='center', style='blue')
-            table.add_column('Status Code', justify='center', style='blue')
-
-            for row in rows[-n_rows:]:
-                table.add_row(*row)
-            layout.update(table)
-            render_map = layout.render(console, console.options)
-
-            if len(render_map[layout].render[-1]) > 2:
-                n_rows -= 1  # The table is overflowing
-            else:
-                break
-
-        return Panel(
-            Align.center(Group(table)),
-            box=box.ROUNDED,
-            padding=(1, 2),
-            title='Monitoring',
-            border_style='bright_blue',
-        )
-
-    try:
-        with open('logs/monitoring.log') as f:
-            f.readlines()
-            width, height = os.get_terminal_size()
-            messages = deque(maxlen=height - 8)  # Save space for header and footer
-
-            with Live(_generate_table(messages), auto_refresh=False, vertical_overflow='visible', screen=True) as live:
-                # TODO: Is it only watch logs/monitoring.log or the whole directory ?
-                for _ in watch('logs/monitoring.log'):
-                    data = f.readline().split('|')
-                    messages.append(data)
-                    live.update(_generate_table(messages))
-                    live.refresh()
-
-    except FileNotFoundError:
-        cli_error("Monitor Log File Does Not Exists.\n\nHint: Make sure 'Monitor' is True in 'core/configs' "
-                  "or you are in a correct directory.")
-    except KeyboardInterrupt:
-        pass

panther-1.7.1/panther.egg-info/requires.txt

@@ -1,12 +0,0 @@
-pantherdb>=1.2.0
-pydantic>=1.10.5
-watchfiles>=0.18.1
-uvicorn[standard]
-bpython>=0.24
-bson>=0.5.10
-redis>=4.0.2
-rich>=13.3.1
-
-[full]
-python-jose>=3.3.0
-pymongo>=4.3.3

{panther-1.7.1 → panther-1.7.3}/panther/logger.py

@@ -2,8 +2,8 @@ import os
 import logging
 from pydantic import BaseModel
 
-from logging.config import dictConfig
 from panther.configs import config
+from logging.config import dictConfig
 
 
 LOGS_DIR = config['base_dir'] / 'logs'