python-plugins 0.1.6__tar.gz → 0.1.9__tar.gz

{python_plugins-0.1.6 → python_plugins-0.1.9}/CHANGES.rst

@@ -1,3 +1,25 @@
+v0.1.9
+------
+
+Released 2024-11-19
+
+- add forms
+
+
+v0.1.8
+------
+
+Released 2024-11-19
+
+- add examples for learning
+
+v0.1.7
+------
+
+Released 2024-10-16
+
+- change html_theme of docs to sphinx_rtd_theme
+
 v0.1.6
 ------
 

{python_plugins-0.1.6 → python_plugins-0.1.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: python-plugins
-Version: 0.1.6
+Version: 0.1.9
 Summary: A collection of Python functions and classes.
 Project-URL: Documentation, https://python-plugins.readthedocs.io
 Project-URL: Source, https://github.com/ojso/python-plugins
@@ -27,7 +27,6 @@ License: MIT License
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
-License-File: LICENSE.rst
 Keywords: plugin,utils
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
@@ -50,6 +49,8 @@ Provides-Extra: requests
 Requires-Dist: requests; extra == 'requests'
 Provides-Extra: sqlalchemy
 Requires-Dist: sqlalchemy; extra == 'sqlalchemy'
+Provides-Extra: wtforms
+Requires-Dist: wtforms; extra == 'wtforms'
 Description-Content-Type: text/x-rst
 
 python-plugins

python_plugins-0.1.9/docs/conf.py

@@ -0,0 +1,51 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'python-plugins'
+copyright = '2024, David Hua'
+author = 'David Hua'
+
+# -- General configuration ---------------------------------------------------
+# -- General configuration
+
+extensions = [
+    "sphinx.ext.duration",
+    "sphinx.ext.doctest",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.intersphinx",
+]
+
+# intersphinx_mapping = {
+#     "rtd": ("https://docs.readthedocs.io/en/stable/", None),
+#     "python": ("https://docs.python.org/3/", None),
+#     "sphinx": ("https://www.sphinx-doc.org/en/master/", None),
+# }
+# intersphinx_disabled_domains = ["std"]
+
+templates_path = ["_templates"]
+
+# -- Options for EPUB output
+epub_show_urls = "footnote"
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "sphinx_rtd_theme"
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ["_static"]

{python_plugins-0.1.6 → python_plugins-0.1.9}/docs/index.rst

@@ -1,7 +1,7 @@
 Welcome to python-plugins's documentation!
 ============================================
 
-**python-plugins** is a Flask extensions with admin, SQLAlchemy, babel, forms, fields, widgets, and so on.
+**python-plugins** is a collection with common python utils.
 
 .. toctree::
    :maxdepth: 2

python_plugins-0.1.9/docs/requirements.txt

@@ -0,0 +1,2 @@
+sphinx
+sphinx_rtd_theme

{python_plugins-0.1.6 → python_plugins-0.1.9}/docs/usage.rst

@@ -57,9 +57,10 @@ remove_pycache
 
 .. code-block:: python
 
-    from  python_plugins.utils.remove_pycache import remove_pycache
+    from  python_plugins.utils import remove_pycache
 
-    remove_pycache(".")
+    remove_pycache()   # default is "."
+    remove_pycache("./tests")
 
 
 weixin.wechat

{python_plugins-0.1.6 → python_plugins-0.1.9}/pyproject.toml

@@ -30,6 +30,7 @@ dependencies = [
 cryptography = ["cryptography"]
 requests = ["requests"]
 sqlalchemy = ["SQLAlchemy"]
+wtforms = ["WTForms"]
 pillow = ["pillow"]
 qrcode = ["qrcode"]
 jwt = ["PyJWT"]

python_plugins-0.1.9/src/python_plugins/__about__.py

@@ -0,0 +1 @@
+__version__ = "0.1.9"

python_plugins-0.1.9/src/python_plugins/__init__.py

@@ -0,0 +1 @@
+from .utils.remove_pycache import remove_pycache

python_plugins-0.1.9/src/python_plugins/convert/pretty.py

@@ -0,0 +1,11 @@
+from re import sub
+
+
+def prettify_class_name(name):
+    """Split words in PascalCase string into separate words.
+
+    :param name:
+        String to split
+    """
+    return sub(r"(?<=.)([A-Z])", r" \1", name)
+

python_plugins-0.1.9/src/python_plugins/crypto/__init__.py

@@ -0,0 +1,2 @@
+from .fernet import generate_fernet_key, fernet_encrypt, fernet_decrypt
+from .file_to_file import encrypt_txtfile, decrypt_txtfile

python_plugins-0.1.9/src/python_plugins/crypto/file_to_file.py

@@ -0,0 +1,70 @@
+import re
+from getpass import getpass
+from .str_to_list import encrypt_str_to_list
+from .str_to_list import decrypt_list_to_str
+
+def get_prompts_line(s, pattern=r"prompts\((\d+)\)"):
+    match = re.search(pattern, s)
+    if match:
+        return int(match[1])
+
+def str_from_txtfile(fin) -> str:
+    with open(fin, encoding="utf-8") as f:
+        s = f.read()
+    return s
+
+
+def str_to_txtfile(s: str, fout=None):
+    if fout is None:
+        print(s)
+    else:
+        with open(fout, "w", encoding="utf-8") as f:
+            f.write(s)
+
+def encrypt_txtfile(fin, fout=None, password=None, prompt='prompts(1)'):
+    s = str_from_txtfile(fin)
+
+    if not prompt:
+        prompt = input("input prompt=")
+
+    if password == "[input]":
+        password = getpass("input password=")
+
+    if password:
+        encrypted_list = encrypt_str_to_list(s, password)
+        encrypted_list[0] = "-"
+    else:
+        encrypted_list = encrypt_str_to_list(s)
+
+    s2 = "\n".join([prompt] + encrypted_list)
+
+    if fout == ".":
+        fout = fin+"_1"
+        
+    str_to_txtfile(s2, fout)
+
+
+def decrypt_txtfile(fin, fout=None, password=None):
+    s = str_from_txtfile(fin)
+    if password == "[input]":
+        password = getpass("input password=")
+    s_list = s.split("\n")
+    prompts = get_prompts_line(s_list[0])
+    if prompts is None:
+        prompts_line = 1
+    else:
+        prompts_line = prompts
+    encrypted_list = s_list[prompts_line:]
+
+    if encrypted_list[0] == "-" and password is None:
+        password = getpass("input password=")
+
+    if password is None:
+        s2 = decrypt_list_to_str(encrypted_list)
+    else:
+        s2 = decrypt_list_to_str(encrypted_list, password)
+        
+    if fout == ".":
+        fout = fin+"_2"
+    str_to_txtfile(s2, fout)
+

{python_plugins-0.1.6 → python_plugins-0.1.9}/src/python_plugins/crypto/str_to_list.py

@@ -54,38 +54,40 @@ def str_randsplit_to_list(s, n1=10, n2=30):
     return r
 
 
-def encrypt_str_to_list(s: str, password=None, prefix=None):
+def encrypt_bytes_to_list(s: bytes, password=None):
     if password is None:
         password = rand_letter(random.randint(6, 16))
-        out_password = password
-    else:
-        out_password = "-"
-    if prefix is not None:
-        password = str(prefix) + password
-
     key, safe_salt, times = get_key(password)
 
     cipher_suite = Fernet(key)
-    encrypted_data = cipher_suite.encrypt(s.encode())
+    encrypted_data = cipher_suite.encrypt(s)
     safe_data = bytes_to_url64str(encrypted_data)
 
-    list_out = [out_password, safe_salt, str(times)] + str_randsplit_to_list(safe_data)
+    list_out = [password, safe_salt, str(times)] + str_randsplit_to_list(safe_data)
 
     return list_out
 
 
-def decrypt_list_to_str(list_in, password=None, prefix=None):
+def decrypt_list_to_bytes(list_in, password=None) -> bytes:
     _password, safe_salt, _times, *_data = list_in
     if password is None:
         password = _password
     else:
         password = password
-    if prefix is not None:
-        password = str(prefix) + password
 
     times = int(_times)
     s = "".join(_data)
     key, _, _ = get_key(password, safe_salt, times)
     cipher_suite = Fernet(key)
     decrypted_bytes = cipher_suite.decrypt(url64str_to_bytes(s))
+    return decrypted_bytes
+
+
+def encrypt_str_to_list(s: str, password=None):
+    arr = encrypt_bytes_to_list(s.encode(), password)
+    return arr
+
+
+def decrypt_list_to_str(list_in, password=None):
+    decrypted_bytes = decrypt_list_to_bytes(list_in, password)
     return decrypted_bytes.decode()

python_plugins-0.1.9/src/python_plugins/examples/higher_order_functions.py

@@ -0,0 +1,40 @@
+import functools
+
+# lambda parameters: expression
+
+lst = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
+
+print(lst)
+
+# map(function, iterable, *iterables) -> iterable
+
+lst_2 = list(map(lambda i: i**2, lst))
+
+print(lst_2)
+
+print([i**2 for i in lst])
+
+lst_3 = list(map(lambda x, y: x + y, lst, lst_2))
+
+print(lst_3)
+
+# filter(function, iterable) -> iterable
+
+result = list(filter(lambda x: x % 2 == 0, lst))
+
+print(result)
+
+print([item for item in lst if item % 2 == 0])
+
+
+# reduce(function, iterable[, initializer])
+
+result = functools.reduce(lambda x, y: x + y, lst)
+
+print(result)
+
+
+# zip(*iterables)
+
+# sorted(iterable, key=None, reverse=False)
+

python_plugins-0.1.9/src/python_plugins/forms/__init__.py

@@ -0,0 +1,2 @@
+from .fields import *
+from .widgets import *

python_plugins-0.1.9/src/python_plugins/forms/fields/__init__.py

@@ -0,0 +1,2 @@
+from .json import JSONField
+from .datetime import DateTimeField

python_plugins-0.1.9/src/python_plugins/forms/fields/datetime.py

@@ -0,0 +1,100 @@
+import time
+import datetime
+from wtforms import fields as wtforms_fields
+from ..widgets.datetime import DateTimePickerWidget
+from ..widgets.datetime import TimePickerWidget
+
+class DateTimeField(wtforms_fields.DateTimeField):
+    """
+    Allows modifying the datetime format of a DateTimeField using form_args.
+    """
+
+    widget = DateTimePickerWidget()
+
+    def __init__(self, label=None, validators=None, format=None, **kwargs):
+        """Constructor
+
+        :param label:
+            Label
+        :param validators:
+            Field validators
+        :param format:
+            Format for text to date conversion. Defaults to '%Y-%m-%d %H:%M:%S'
+        :param kwargs:
+            Any additional parameters
+        """
+        super().__init__(
+            label, validators, format or "%Y-%m-%d %H:%M:%S", **kwargs
+        )
+
+
+class TimeField(wtforms_fields.Field):
+    """
+    A text field which stores a `datetime.time` object.
+    Accepts time string in multiple formats: 20:10, 20:10:00, 10:00 am, 9:30pm, etc.
+    """
+
+    widget = TimePickerWidget()
+
+    def __init__(
+        self,
+        label=None,
+        validators=None,
+        formats=None,
+        default_format=None,
+        widget_format=None,
+        **kwargs
+    ):
+        """
+        Constructor
+
+        :param label:
+            Label
+        :param validators:
+            Field validators
+        :param formats:
+            Supported time formats, as a enumerable.
+        :param default_format:
+            Default time format. Defaults to '%H:%M:%S'
+        :param kwargs:
+            Any additional parameters
+        """
+        super(TimeField, self).__init__(label, validators, **kwargs)
+
+        self.formats = formats or (
+            "%H:%M:%S",
+            "%H:%M",
+            "%I:%M:%S%p",
+            "%I:%M%p",
+            "%I:%M:%S %p",
+            "%I:%M %p",
+        )
+
+        self.default_format = default_format or "%H:%M:%S"
+
+    def _value(self):
+        if self.raw_data:
+            return " ".join(self.raw_data)
+        elif self.data is not None:
+            return self.data.strftime(self.default_format)
+        else:
+            return ""
+
+    def process_formdata(self, valuelist):
+        if valuelist:
+            date_str = " ".join(valuelist)
+
+            if date_str.strip():
+                for format in self.formats:
+                    try:
+                        timetuple = time.strptime(date_str, format)
+                        self.data = datetime.time(
+                            timetuple.tm_hour, timetuple.tm_min, timetuple.tm_sec
+                        )
+                        return
+                    except ValueError:
+                        pass
+
+                raise ValueError(self.gettext("Invalid time format"))
+            else:
+                self.data = None

python_plugins-0.1.9/src/python_plugins/forms/fields/json.py

@@ -0,0 +1,19 @@
+import json
+from wtforms.fields import TextAreaField
+
+class JSONField(TextAreaField):
+    def process_formdata(self, valuelist):
+        if valuelist:
+            if not valuelist[0]:
+                self.data = None
+                return
+            try:
+                self.data = json.loads(valuelist[0])
+            except ValueError:
+                raise ValueError(self.gettext("Invalid JSON"))
+
+    def _value(self):
+        if self.data:
+            return json.dumps(self.data, ensure_ascii=False)
+        else:
+            return ""

python_plugins-0.1.9/src/python_plugins/forms/fields/select.py

@@ -0,0 +1,123 @@
+import re
+from wtforms import fields as wtforms_fields
+from ..widgets.select import Select2Widget
+from ..widgets.select import Select2TagsWidget
+
+
+class Select2Field(wtforms_fields.SelectField):
+    """
+    `Select2 <https://github.com/ivaynberg/select2>`_ styled select widget.
+
+    You must include select2.js, form-x.x.x.js and select2 stylesheet for it to
+    work.
+    """
+
+    widget = Select2Widget()
+
+    def __init__(
+        self,
+        label=None,
+        validators=None,
+        coerce=str,
+        choices=None,
+        allow_blank=False,
+        blank_text=None,
+        **kwargs
+    ):
+        super(Select2Field, self).__init__(label, validators, coerce, choices, **kwargs)
+        self.allow_blank = allow_blank
+        self.blank_text = blank_text or " "
+
+    def iter_choices(self):
+        if self.allow_blank:
+            yield ("__None", self.blank_text, self.data is None)
+
+        for choice in self.choices:
+            if isinstance(choice, tuple):
+                yield (choice[0], choice[1], self.coerce(choice[0]) == self.data)
+            else:
+                yield (
+                    choice.value,
+                    choice.name,
+                    self.coerce(choice.value) == self.data,
+                )
+
+    def process_data(self, value):
+        if value is None:
+            self.data = None
+        else:
+            try:
+                self.data = self.coerce(value)
+            except (ValueError, TypeError):
+                self.data = None
+
+    def process_formdata(self, valuelist):
+        if valuelist:
+            if valuelist[0] == "__None":
+                self.data = None
+            else:
+                try:
+                    self.data = self.coerce(valuelist[0])
+                except ValueError:
+                    raise ValueError(self.gettext("Invalid Choice: could not coerce"))
+
+    def pre_validate(self, form):
+        if self.allow_blank and self.data is None:
+            return
+
+        super(Select2Field, self).pre_validate(form)
+
+
+class Select2TagsField(wtforms_fields.StringField):
+    """`Select2 <http://ivaynberg.github.com/select2/#tags>`_ styled text field.
+    You must include select2.js, form-x.x.x.js and select2 stylesheet for it to work.
+    """
+
+    widget = Select2TagsWidget()
+    _strip_regex = re.compile(
+        r"#\d+(?:(,)|\s$)"
+    )  # e.g., 'tag#123, anothertag#425 ' => 'tag, anothertag'
+
+    def __init__(
+        self,
+        label=None,
+        validators=None,
+        save_as_list=False,
+        coerce=str,
+        allow_duplicates=False,
+        **kwargs
+    ):
+        """Initialization
+
+        :param save_as_list:
+            If `True` then populate ``obj`` using list else string
+        :param allow_duplicates
+            If `True` then duplicate tags are allowed in the field.
+        """
+        self.save_as_list = save_as_list
+        self.allow_duplicates = allow_duplicates
+        self.coerce = coerce
+
+        super(Select2TagsField, self).__init__(label, validators, **kwargs)
+
+    def process_formdata(self, valuelist):
+        if valuelist:
+            entrylist = valuelist[0]
+            if self.allow_duplicates and entrylist.endswith(" "):
+                # This means this is an allowed duplicate (see form.js, `createSearchChoice`), so its ID was modified.
+                # Hence, we need to restore the original IDs.
+                entrylist = re.sub(self._strip_regex, "\\1", entrylist)
+            if self.save_as_list:
+                self.data = [
+                    self.coerce(v.strip()) for v in entrylist.split(",") if v.strip()
+                ]
+            else:
+                self.data = self.coerce(entrylist)
+
+    def _value(self):
+        if isinstance(self.data, (list, tuple)):
+            return ",".join(v for v in self.data)
+        elif self.data:
+            return self.data
+        else:
+            return ""

python_plugins-0.1.9/src/python_plugins/forms/fields/switch.py

@@ -0,0 +1,10 @@
+from wtforms.fields import BooleanField
+
+
+class SwitchField(BooleanField):
+    """
+    A wrapper field for ``BooleanField`` that renders as a Bootstrap switch.
+    """
+
+    def __init__(self, label=None, **kwargs):
+        super().__init__(label, **kwargs)

python_plugins-0.1.9/src/python_plugins/forms/fields/taglist.py

@@ -0,0 +1,9 @@
+from wtforms.fields import StringField
+
+class TagListField(StringField):
+    def process_formdata(self, valuelist):
+        if valuelist:
+            self.data = [x.strip() for x in valuelist[0].split(",")]
+
+    def _value(self):
+        return ",".join(self.data) if self.data is not None else ""

python_plugins-0.1.9/src/python_plugins/forms/widgets/datetime.py

@@ -0,0 +1,30 @@
+from wtforms.widgets import TextInput
+
+
+class DatePickerWidget(TextInput):
+    """Date picker widget."""
+
+    def __call__(self, field, **kwargs):
+        kwargs.setdefault("data-role", "datepicker")
+        kwargs.setdefault("data-date-format", "YYYY-MM-DD")
+
+        self.date_format = kwargs["data-date-format"]
+        return super().__call__(field, **kwargs)
+
+
+class DateTimePickerWidget(TextInput):
+    """Datetime picker widget."""
+
+    def __call__(self, field, **kwargs):
+        kwargs.setdefault("data-role", "datetimepicker")
+        kwargs.setdefault("data-date-format", "YYYY-MM-DD HH:mm:ss")
+        return super().__call__(field, **kwargs)
+
+
+class TimePickerWidget(TextInput):
+    """Date picker widget."""
+
+    def __call__(self, field, **kwargs):
+        kwargs.setdefault("data-role", "timepicker")
+        kwargs.setdefault("data-date-format", "HH:mm:ss")
+        return super().__call__(field, **kwargs)

python_plugins-0.1.9/src/python_plugins/forms/widgets/file.py

@@ -0,0 +1,4 @@
+from wtforms.widgets import FileInput
+
+class ImageInput(FileInput):
+    field_flags = {"accept": "image/*"}

python_plugins-0.1.9/src/python_plugins/forms/widgets/select.py

@@ -0,0 +1,26 @@
+from wtforms.widgets import Select
+from wtforms.widgets import TextInput
+
+
+class Select2Widget(Select):
+    """Select2 Widget."""
+
+    def __call__(self, field, **kwargs):
+        kwargs.setdefault("data-role", "select2")
+        allow_blank = getattr(field, "allow_blank", False)
+        if allow_blank and not self.multiple:
+            kwargs["data-allow-blank"] = "1"
+
+        return super().__call__(field, **kwargs)
+
+
+class Select2TagsWidget(TextInput):
+    """Select2Tags Widget."""
+
+    def __call__(self, field, **kwargs):
+        kwargs.setdefault("data-role", "select2-tags")
+        kwargs.setdefault(
+            "data-allow-duplicate-tags",
+            "true" if getattr(field, "allow_duplicates", False) else "false",
+        )
+        return super().__call__(field, **kwargs)

python_plugins-0.1.9/src/python_plugins/utils/__init__.py

@@ -0,0 +1 @@
+from .remove_pycache import remove_pycache

{python_plugins-0.1.6 → python_plugins-0.1.9}/src/python_plugins/utils/remove_pycache.py

@@ -1,7 +1,7 @@
 import os
 import shutil
 
-def remove_pycache(dir_path):
+def remove_pycache(dir_path="."):
     for root, dirs, files in os.walk(dir_path):
         if "venv" in root or "git" in root:
             continue