AdvancedTagscript 3.2.3__py3-none-any.whl

TagScriptEngine/verb.py

@@ -0,0 +1,160 @@
+from __future__ import annotations
+
+from typing import Optional, Protocol, Tuple
+
+__all__: Tuple[str, ...] = ("Verb",)
+
+
+class _Verb(Protocol):
+    def __init__(
+        self, verb_string: Optional[str] = None, *, limit: int = 2000, dot_parameter: bool = False
+    ) -> None: ...
+
+    def __parse(self, verb_string: str, limit: int) -> None: ...
+
+    def _parse_paranthesis_parameter(self, i: int, v: str) -> bool: ...
+
+    def _parse_dot_parameter(self, i: int, v: str) -> bool: ...
+
+    def set_payload(self) -> None: ...
+
+    def open_parameter(self, i: int) -> None: ...
+
+    def close_parameter(self, i: int) -> bool: ...
+
+
+class Verb(_Verb):
+    """
+    Represents the passed TagScript block.
+
+    Parameters
+    ----------
+    verb_string: Optional[str]
+        The string to parse into a verb.
+    limit: int
+        The maximum number of characters to parse.
+    dot_parameter: bool
+        Whether the parameter should be followed after a "." or use the default of parantheses.
+
+    Attributes
+    ----------
+    declaration: Optional[str]
+        The text used to declare the block.
+    parameter: Optional[str]
+        The text passed to the block parameter in the parentheses.
+    payload: Optional[str]
+        The text passed to the block payload after the colon.
+
+    Example
+    -------
+    Below is a visual representation of a block and its attributes::
+
+        {declaration(parameter):payload}
+
+        # dot_parameter = True
+        {declaration.parameter:payload}
+    """
+
+    __slots__: Tuple[str, ...] = (
+        "declaration",
+        "parameter",
+        "payload",
+        "parsed_string",
+        "dec_depth",
+        "dec_start",
+        "skip_next",
+        "parsed_length",
+        "dot_parameter",
+    )
+
+    def __init__(
+        self, verb_string: Optional[str] = None, *, limit: int = 2000, dot_parameter: bool = False
+    ) -> None:
+        self.declaration: Optional[str] = None
+        self.parameter: Optional[str] = None
+        self.payload: Optional[str] = None
+        self.dot_parameter = dot_parameter
+        if verb_string is None:
+            return
+        self.__parse(verb_string, limit)
+
+    def __str__(self) -> str:
+        """This makes Verb compatible with str(x)"""
+        response = "{"
+        if self.declaration is not None:
+            response += self.declaration
+        if self.parameter is not None:
+            response += f".{self.parameter}" if self.dot_parameter else f"({self.parameter})"
+        if self.payload is not None:
+            response += ":" + self.payload
+        return response + "}"
+
+    def __repr__(self) -> str:
+        attrs = ("declaration", "parameter", "payload")
+        inner = " ".join(f"{attr}={getattr(self, attr)!r}" for attr in attrs)
+        return f"<Verb {inner}>"
+
+    def __parse(self, verb_string: str, limit: int) -> None:
+        self.parsed_string = verb_string[1:-1][:limit]
+        self.parsed_length = len(self.parsed_string)
+        self.dec_depth = 0
+        self.dec_start = 0
+        self.skip_next = False
+
+        parse_parameter = (
+            self._parse_dot_parameter if self.dot_parameter else self._parse_paranthesis_parameter
+        )
+
+        for i, v in enumerate(self.parsed_string):
+            if self.skip_next:
+                self.skip_next = False
+                continue
+            elif v == "\\":
+                self.skip_next = True
+                continue
+
+            if v == ":" and not self.dec_depth:
+                self.set_payload()
+                return
+            elif parse_parameter(i, v):
+                return
+        else:
+            self.set_payload()
+
+    def _parse_paranthesis_parameter(self, i: int, v: str) -> bool:
+        if v == "(":
+            self.open_parameter(i)
+        elif v == ")" and self.dec_depth:
+            return self.close_parameter(i)
+        return False
+
+    def _parse_dot_parameter(self, i: int, v: str) -> bool:
+        if v == ".":
+            self.open_parameter(i)
+        elif (v == ":" or i == self.parsed_length - 1) and self.dec_depth:
+            return self.close_parameter(i + 1)
+        return False
+
+    def set_payload(self) -> None:
+        res = self.parsed_string.split(":", 1)
+        if len(res) == 2:
+            self.payload = res[1]
+        self.declaration = res[0]
+
+    def open_parameter(self, i: int) -> None:
+        self.dec_depth += 1
+        if not self.dec_start:
+            self.dec_start = i
+            self.declaration = self.parsed_string[:i]
+
+    def close_parameter(self, i: int) -> bool:
+        self.dec_depth -= 1
+        if self.dec_depth == 0:
+            self.parameter = self.parsed_string[self.dec_start + 1 : i]
+            try:
+                if self.parsed_string[i + 1] == ":":
+                    self.payload = self.parsed_string[i + 2 :]
+            except IndexError:
+                pass
+            return True
+        return False

advancedtagscript-3.2.3.dist-info/METADATA

@@ -0,0 +1,99 @@
+Metadata-Version: 2.4
+Name: AdvancedTagscript
+Version: 3.2.3
+Summary: An easy drop in user-provided Templating system.
+Home-page: https://github.com/cool-aid-man/TagScriptEngine
+Author: cool-aid-man, inthedark.org, PhenoM4n4n
+Author-email: coolaid@duskybot.xyz
+License: Creative Commons Attribution 4.0 International License
+Keywords: tagscript,string-templating,discord.py
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: Freely Distributable
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+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
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+License-File: LICENSE
+Requires-Dist: pyparsing
+Requires-Dist: typing_extensions
+Provides-Extra: discord
+Requires-Dist: discord.py>=2.4.0; extra == "discord"
+Provides-Extra: all
+Requires-Dist: orjson; extra == "all"
+Requires-Dist: discord.py>=2.4.0; extra == "all"
+Dynamic: license-file
+
+## Information
+<a href="https://pypi.python.org/pypi/AdvancedTagscriptEngine/">
+    <img src="https://img.shields.io/pypi/pyversions/AdvancedTagscriptEngine" alt="AdvancedTagScriptEngine" />
+</a>
+<a href="https://pypi.python.org/pypi/AdvancedTagscriptEngine/">
+    <img src="https://img.shields.io/pypi/v/AdvancedTagScriptEngine" alt="PyPI - Version">
+</a>
+<a href="https://advancedtagscript.readthedocs.io/en/latest/?badge=latest">
+    <img src="https://readthedocs.org/projects/tagscriptengine/badge/?version=latest" alt="Documentation Status" />
+</a>
+<a href="https://pypi.python.org/pypi/AdvancedTagscriptEngine/">
+    <img src="https://img.shields.io/pypi/dm/AdvancedTagScriptEngine" alt="PyPI - Downloads" />
+
+</a>
+
+This repository is a fork of JonSnowbd's [TagScript](https://github.com/JonSnowbd/TagScript), a string templating language.
+This fork adds support for Discord object adapters and a couple Discord related blocks, as
+well as multiple utility blocks. Additionally, several tweaks have been made to the engine's
+behavior.
+
+This TagScriptEngine is used on [Dusky, a Discord bot](https://duskybot.xyz/invite).
+An example implementation can be found in the [Tags cog](https://github.com/cool-aid-man/cool-cogs/tree/main/tags).
+
+Additional documentation on the TagScriptEngine library can be [found here](https://advancedtagscript.readthedocs.io/en/latest/).
+
+## Installation
+
+Download the latest version through pip:
+
+```
+pip(3) install AdvancedTagScriptEngine
+```
+
+Download from a commit:
+
+```
+pip(3) install git+https://github.com/cool-aid-man/TagScriptEngine.git@<COMMIT_HASH>
+```
+
+Install for editing/development:
+
+```
+git clone https://github.com/cool-aid-man/TagScriptEngine.git
+pip(3) install -e ./TagScriptEngine
+```
+
+## What?
+
+AdvancedTagScriptEngine is a drop in easy to use string interpreter that lets you provide users with ways of
+customizing their profiles or chat rooms with interactive text.
+
+For example TagScript comes out of the box with a random block that would let users provide
+a template that produces a new result each time its ran, or assign math and variables for later
+use.
+
+## Dependencies
+
+`Python 3.8+`
+
+`pyparsing`
+
+`discord.py`
+
+`Red-DiscordBot` [optional]

advancedtagscript-3.2.3.dist-info/RECORD

@@ -0,0 +1,48 @@
+TagScriptEngine/__init__.py,sha256=M4Pyq-cF6NPjDajbQF3qA8cSYXWIhUN6EZgOsP5ba88,5911
+TagScriptEngine/_warnings.py,sha256=pfMXaEVGpIue0eqgzZ6HkLXEka1UGl61-yuH9uEnVe4,2662
+TagScriptEngine/exceptions.py,sha256=lhvskKi2AySE5pul_iAA251jdMv-92QkjodR4X-G27Y,2833
+TagScriptEngine/interpreter.py,sha256=oiyKNXgZCsMmcCTkRnszVIqG_to7PmQKomCn_pX5sb8,16604
+TagScriptEngine/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+TagScriptEngine/utils.py,sha256=Kq7_w6nuJizPYZDJIzXZ51b1ea92_7Vm_YDKbQci7F4,1697
+TagScriptEngine/verb.py,sha256=nk5IenRRGuwzIY7cMyGQn7aVYvmGcNTszztAQTSHP54,5047
+TagScriptEngine/adapter/__init__.py,sha256=9ohds_8-zbVKZobQCE7xb96XrF6Be8lCSjJCJHHSuDM,1266
+TagScriptEngine/adapter/discordadapters.py,sha256=l_6HijmmGDRX7lhahskH6mTteJFpS7IcMEvnKPqIQhY,19005
+TagScriptEngine/adapter/functionadapter.py,sha256=lQlWm0dO-41bTQ2etFpWRaGnG22V1HMy9aiB8FnFZOU,591
+TagScriptEngine/adapter/intadapter.py,sha256=jENx5ah8k0U1PjJccV0NiYFsWFU9ZXTFgz3f-qx30SA,548
+TagScriptEngine/adapter/objectadapter.py,sha256=7bW-Qd6gujq2ALdK3p0ONoCSPWCTv6srkkDNjzkvDEU,1017
+TagScriptEngine/adapter/redbotadapters.py,sha256=AFCu4QZGSHAMwyDFHBPT9XS5aaWVzj9Hu-pwI87DXi8,5934
+TagScriptEngine/adapter/stringadapter.py,sha256=VaJzkm1b8b7w1T90DjR3gOH0DIsZlWtcFe1YG7DOqBQ,1710
+TagScriptEngine/block/__init__.py,sha256=pWsnL9GJ69UmZf-VCxwdAb9Kv89KNyVw_fFM7MV0NkM,2994
+TagScriptEngine/block/allowedmentions.py,sha256=WMGWi1Fe0U_vUBsc4uyiX1XfQjGkhpdlyvq3HhCCLd4,2219
+TagScriptEngine/block/assign.py,sha256=l3DO41BVoXZbGSHsscSdNiSLddT7ggt1bPQoJdM1Iuo,1202
+TagScriptEngine/block/breakblock.py,sha256=nt3T7fDhTxH0jpO8lu0_3oC4XwVuKKg9cmkdLsZwzL8,1288
+TagScriptEngine/block/case.py,sha256=0DDWG9iN1uI5kE_NaZ2Ewfwg5Ki0nph0jHL2W1YQqdY,1442
+TagScriptEngine/block/command.py,sha256=1ljbZd_Mgg6Woqi6giz26coCRej-jyh4ENY_cdTwjK8,4307
+TagScriptEngine/block/comment.py,sha256=wsie7-PTupqDcuHNCflYiVip4sehR7S28GQzuXIJOQo,675
+TagScriptEngine/block/control.py,sha256=tALrHN0vbEXheMhoQOI_C0X_WjL3c-Qqd2zEd0rAZrE,5699
+TagScriptEngine/block/cooldown.py,sha256=F4HmFoIlxIhDWw8Z8PFZqP1FoEEBmAW4aipByZKZocY,4022
+TagScriptEngine/block/count.py,sha256=J_9t1N7huGktOvJTvs9jxS9z8ayK3BpB35MWbmuba2s,1867
+TagScriptEngine/block/embedblock.py,sha256=NbudZCln0lEKO8WD5Zmh3W56E5jzmwBMezEaIbGcyqU,11008
+TagScriptEngine/block/fiftyfifty.py,sha256=QjQP96vpQPRVpuVcF5iI1kTCkM54vUBpKgK2TEZU6vQ,827
+TagScriptEngine/block/helpers.py,sha256=Zevy0tWzDAUKSD9hc6-nW7WTreRhqENgalfySwqhF7U,4386
+TagScriptEngine/block/loosevariablegetter.py,sha256=ym6u9HTWKN-Cgk6OQH5FVIiGnxsND2g5o4r3kRBGH9M,1231
+TagScriptEngine/block/mathblock.py,sha256=r69oCNUAjcGNO0QFBG7w9XCv7mvMrq__GoyhR7pW6fA,5802
+TagScriptEngine/block/randomblock.py,sha256=udC7mCGYrtN_Exg1XZZvqvvi8KkGNnRyTkuh-6rbeSo,1594
+TagScriptEngine/block/range.py,sha256=3dz6jgTIBloZyXgN7eXGsB7SBjK3Y-OJROmHOeOaJT4,1836
+TagScriptEngine/block/redirect.py,sha256=BobWl6xKqVV4FZlihmJoLPwI_i0P6Sn6G6fWFf9d8CE,1140
+TagScriptEngine/block/replaceblock.py,sha256=JbW-TEIQO4EgeZ3KKPKY2oIKKkVOq-syI4sIzN--OVk,3372
+TagScriptEngine/block/require_blacklist.py,sha256=3jFK8Ap_ataHZrqF3MWrmXrBI5CkIXq8G6QMEq0QQXY,2810
+TagScriptEngine/block/shortcutredirect.py,sha256=2F20L_7hYMxJY9s02XwxJQIWXaBQM_dwBNZKsOJQsk8,683
+TagScriptEngine/block/stopblock.py,sha256=eqNmy9ZUgstU-D7Vg5E5aOXxQSD1Dd1D1wH4rcXQEZQ,1090
+TagScriptEngine/block/strf.py,sha256=xL5HL8ADRnb2bYTCaRjZkV4K4y6ZMIb_HEONfTCdT4k,2048
+TagScriptEngine/block/strictvariablegetter.py,sha256=XMwqGad3iy5esB2aTiD5v1EaCLGDFMvB1RF11G0-l2M,1251
+TagScriptEngine/block/substr.py,sha256=QNtoOIBBC-tD2v4vT1NzmrSA5THJ_pOqQLezxWED8ek,835
+TagScriptEngine/block/urlencodeblock.py,sha256=NlCSAbAgfPvG4Jh0L1ct8VyS9i4ow6V_5VXKsM36mNk,1398
+TagScriptEngine/interface/__init__.py,sha256=37lAOMONKmWDLiC5Ox9Y3TNQUQbzW54oUugbQe0e9gc,341
+TagScriptEngine/interface/adapter.py,sha256=4jBBz7hc-8fsRSZ5DWOrUxrhXqS0SvJCdW57TZl8sQo,1967
+TagScriptEngine/interface/block.py,sha256=S0hWRH6uqBz_cYRIh3LGMyo63UK6gNidtf6EiLUKL0c,3653
+advancedtagscript-3.2.3.dist-info/licenses/LICENSE,sha256=NvdimESU3jrNgd_8E4i-eTecQ_jGegRrrWk1v2gOnHY,252
+advancedtagscript-3.2.3.dist-info/METADATA,sha256=3_PWQSnBpRc67XR6oz_r42s1nEztA0gAoI9B-fzor4M,3707
+advancedtagscript-3.2.3.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+advancedtagscript-3.2.3.dist-info/top_level.txt,sha256=6lY4lZDvWxraERrit1lvDsCCDdfo9e83kk_tBemAJCo,16
+advancedtagscript-3.2.3.dist-info/RECORD,,

advancedtagscript-3.2.3.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

advancedtagscript-3.2.3.dist-info/licenses/LICENSE

@@ -0,0 +1 @@
+This work is licensed under the Creative Commons Attribution 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by/4.0/ or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.

advancedtagscript-3.2.3.dist-info/top_level.txt

@@ -0,0 +1 @@
+TagScriptEngine