Pyjoyment 0.1.0__py3-none-any.whl

Pyjo/HelloWorld.py

@@ -0,0 +1,77 @@
+"""
+Pyjo.HelloWorld - Hello World!
+==============================
+::
+
+    from Pyjo.HelloWorld import HelloWorld
+
+    hello = HelloWorld()
+    hello.start()
+
+    # Or import the module, as in Google Python Style Guide
+
+    import Pyjo.HelloWorld
+
+    hello = Pyjo.HelloWorld.new()
+    hello.start()
+
+:mod:`Pyjo.HelloWorld` is the default application of :mod:`Pyjo.Server`, used
+mostly for testing. It answers every request with ``Your Pyjo is working!``,
+and is a :mod:`Pyjo.App` without :mod:`Pyjoyment`, whose counterpart is
+:mod:`Pyjoyment.HelloWorld`.
+
+See also
+--------
+
+:mod:`Pyjo.App`, :mod:`Pyjoyment.HelloWorld`, https://mojolicious.org.
+
+Inspired by `Mojo::HelloWorld <https://github.com/mojolicious/mojo/blob/v9.49/lib/Mojo/HelloWorld.pm>`_ of
+Mojolicious 9.49, an application of Mojolicious, which :mod:`Pyjoyment.HelloWorld` ports.
+
+Classes
+-------
+"""
+
+import Pyjo.App
+import Pyjo.Log
+
+from typing import Any
+
+
+class Pyjo_HelloWorld(Pyjo.App.object):
+    """
+    :mod:`Pyjo.HelloWorld` inherits all attributes and methods from
+    :mod:`Pyjo.App` and implements the following new ones.
+    """
+
+    def __init__(self, attrs: dict[str, Any] | None = None, /, **kwargs: Any) -> None:
+        """::
+
+            hello = Pyjo.HelloWorld.new()
+            hello = Pyjo.HelloWorld.new(log=Pyjo.Log.new())
+
+        Construct a new :mod:`Pyjo.HelloWorld` object, which logs errors only
+        unless it gets a :attr:`~Pyjo.App.Pyjo_App.log`.
+        """
+        super().__init__(attrs, **kwargs)
+        if self._log is None:
+            self._log = Pyjo.Log.new(level='error')
+
+    def handler(self, tx: Any) -> None:
+        """::
+
+            hello.handler(Pyjo.Transaction.HTTP.new())
+
+        Handle the request of the transaction with the response
+        ``Your Pyjo is working!``.
+        """
+        res = tx.res
+        res.code = 200
+        res.headers.content_type = 'text/html;charset=UTF-8'
+        res.body = b'Your Pyjo is working!'
+        tx.resume()
+
+
+new = Pyjo_HelloWorld.new
+object = Pyjo_HelloWorld
+HelloWorld = Pyjo_HelloWorld

Pyjo/Home.py

@@ -0,0 +1,109 @@
+"""
+Pyjo.Home - Home sweet home
+===========================
+::
+
+    from Pyjo.Home import Home
+
+    # Find and manage the project root directory
+    home = Home()
+    home.detect()
+    print(home.child('templates', 'layouts', 'default.html.ep'))
+    print(f'{home}')
+
+    # Or import the module, as in Google Python Style Guide
+
+    import Pyjo.Home
+
+    # Find and manage the project root directory
+    home = Pyjo.Home.new()
+    home.detect()
+    print(home.child('templates', 'layouts', 'default.html.ep'))
+    print(f'{home}')
+
+:mod:`Pyjo.Home` is a container for home directories based on
+:mod:`Pyjo.File`.
+
+See also
+--------
+
+:mod:`Pyjoyment`, https://mojolicious.org.
+
+Ported from `Mojo::Home <https://github.com/mojolicious/mojo/blob/v9.49/lib/Mojo/Home.pm>`_
+of Mojolicious 9.49.
+"""
+
+import Pyjo.File
+
+import os
+import sys
+
+from types import ModuleType
+from typing import Self
+
+
+class Pyjo_Home(Pyjo.File.object):
+    """
+    :mod:`Pyjo.Home` inherits all methods from :mod:`Pyjo.File` and
+    implements the following new ones.
+    """
+
+    def detect(self, cls: type | ModuleType | str | None = None) -> Self:
+        """::
+
+            home = home.detect()
+            home = home.detect(MyApp)
+            home = home.detect('My.App')
+
+        Detect home directory from the value of the ``PYJO_HOME`` environment
+        variable or the location of the application class: a class, its
+        module, or the dotted name of a module that is loaded. The directory
+        of the module's file, less the parts of the name of the module and a
+        ``lib``, ``blib/lib`` or ``src`` directory, is the home.
+        """
+        # Environment variable
+        home: list[str] | None = None
+        if os.environ.get('PYJO_HOME'):
+            home = Pyjo.File.new(os.environ['PYJO_HOME']).to_list()
+
+        # Location of the application class
+        elif cls is not None and (module := _module(cls)) is not None and (file := getattr(module, '__file__', None)):
+            home = Pyjo.File.new(file).to_list()
+            parts = len(module.__name__.split('.')) + (Pyjo.File.new(file).basename() == '__init__.py')
+            del home[-parts:]
+            for name in ('lib', 'blib'):
+                if home and home[-1] == name:
+                    home.pop()
+            # Not in Mojolicious: the src directory of a Python project, as lib is of a Perl one
+            if home and home[-1] == 'src':
+                home.pop()
+
+        if home is not None:
+            self._path = Pyjo.File.new(*home).to_abs().to_str()
+        return self
+
+    def rel_file(self, path: str) -> Self:
+        """::
+
+            path = home.rel_file('foo/bar.html')
+
+        Return a new :mod:`Pyjo.Home` object relative to the home directory.
+        """
+        return self.child(*path.split('/'))
+
+
+# The module of a class, a module, or the longest prefix of a dotted name that is loaded
+def _module(cls: type | ModuleType | str) -> ModuleType | None:
+    if isinstance(cls, ModuleType):
+        return cls
+    name = cls.__module__ if isinstance(cls, type) else cls
+    parts = name.split('.')
+    for i in range(len(parts), 0, -1):
+        if (module := sys.modules.get('.'.join(parts[:i]))) is not None:
+            return module
+    return None
+
+
+new = Pyjo_Home.new
+object = Pyjo_Home
+Home = Pyjo_Home