AdvancedTagscript 3.2.3__tar.gz

advancedtagscript-3.2.3/AdvancedTagscript.egg-info/PKG-INFO

@@ -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/AdvancedTagscript.egg-info/SOURCES.txt

@@ -0,0 +1,59 @@
+LICENSE
+MANIFEST.in
+README.md
+pyproject.toml
+setup.cfg
+setup.py
+AdvancedTagscript.egg-info/PKG-INFO
+AdvancedTagscript.egg-info/SOURCES.txt
+AdvancedTagscript.egg-info/dependency_links.txt
+AdvancedTagscript.egg-info/requires.txt
+AdvancedTagscript.egg-info/top_level.txt
+TagScriptEngine/__init__.py
+TagScriptEngine/_warnings.py
+TagScriptEngine/exceptions.py
+TagScriptEngine/interpreter.py
+TagScriptEngine/py.typed
+TagScriptEngine/utils.py
+TagScriptEngine/verb.py
+TagScriptEngine/adapter/__init__.py
+TagScriptEngine/adapter/discordadapters.py
+TagScriptEngine/adapter/functionadapter.py
+TagScriptEngine/adapter/intadapter.py
+TagScriptEngine/adapter/objectadapter.py
+TagScriptEngine/adapter/redbotadapters.py
+TagScriptEngine/adapter/stringadapter.py
+TagScriptEngine/block/__init__.py
+TagScriptEngine/block/allowedmentions.py
+TagScriptEngine/block/assign.py
+TagScriptEngine/block/breakblock.py
+TagScriptEngine/block/case.py
+TagScriptEngine/block/command.py
+TagScriptEngine/block/comment.py
+TagScriptEngine/block/control.py
+TagScriptEngine/block/cooldown.py
+TagScriptEngine/block/count.py
+TagScriptEngine/block/embedblock.py
+TagScriptEngine/block/fiftyfifty.py
+TagScriptEngine/block/helpers.py
+TagScriptEngine/block/loosevariablegetter.py
+TagScriptEngine/block/mathblock.py
+TagScriptEngine/block/randomblock.py
+TagScriptEngine/block/range.py
+TagScriptEngine/block/redirect.py
+TagScriptEngine/block/replaceblock.py
+TagScriptEngine/block/require_blacklist.py
+TagScriptEngine/block/shortcutredirect.py
+TagScriptEngine/block/stopblock.py
+TagScriptEngine/block/strf.py
+TagScriptEngine/block/strictvariablegetter.py
+TagScriptEngine/block/substr.py
+TagScriptEngine/block/urlencodeblock.py
+TagScriptEngine/interface/__init__.py
+TagScriptEngine/interface/adapter.py
+TagScriptEngine/interface/block.py
+tests/test_adapters.py
+tests/test_basic.py
+tests/test_edgecase.py
+tests/test_escapes.py
+tests/test_verbs.py

advancedtagscript-3.2.3/AdvancedTagscript.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

advancedtagscript-3.2.3/AdvancedTagscript.egg-info/requires.txt

@@ -0,0 +1,9 @@
+pyparsing
+typing_extensions
+
+[all]
+orjson
+discord.py>=2.4.0
+
+[discord]
+discord.py>=2.4.0

advancedtagscript-3.2.3/AdvancedTagscript.egg-info/top_level.txt

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

advancedtagscript-3.2.3/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/MANIFEST.in

@@ -0,0 +1,2 @@
+include LICENSE
+include README.md

advancedtagscript-3.2.3/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,64 @@
+## 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/TagScriptEngine/__init__.py

@@ -0,0 +1,227 @@
+from __future__ import annotations
+
+from typing import Final, NamedTuple, Tuple
+
+from .adapter import (
+    SafeObjectAdapter as SafeObjectAdapter,
+    StringAdapter as StringAdapter,
+    IntAdapter as IntAdapter,
+    FunctionAdapter as FunctionAdapter,
+    DiscordAttributeAdapter as DiscordAttributeAdapter,
+    UserAdapter as UserAdapter,
+    MemberAdapter as MemberAdapter,
+    DMChannelAdapter as DMChannelAdapter,
+    ChannelAdapter as ChannelAdapter,
+    GuildAdapter as GuildAdapter,
+    RoleAdapter as RoleAdapter,
+    AttributeAdapter as AttributeAdapter,
+    DiscordObjectAdapter as DiscordObjectAdapter,
+    RedCommandAdapter as RedCommandAdapter,
+    RedBotAdapter as RedBotAdapter,
+)
+from .block import (
+    implicit_bool as implicit_bool,
+    helper_parse_if as helper_parse_if,
+    helper_parse_list_if as helper_parse_list_if,
+    helper_split as helper_split,
+    AllowedMentionsBlock as AllowedMentionsBlock,
+    AllBlock as AllBlock,
+    AnyBlock as AnyBlock,
+    AssignmentBlock as AssignmentBlock,
+    BlacklistBlock as BlacklistBlock,
+    BreakBlock as BreakBlock,
+    SequentialGather as SequentialGather,
+    CommandBlock as CommandBlock,
+    EmbedBlock as EmbedBlock,
+    FiftyFiftyBlock as FiftyFiftyBlock,
+    IfBlock as IfBlock,
+    LooseVariableGetterBlock as LooseVariableGetterBlock,
+    MathBlock as MathBlock,
+    OverrideBlock as OverrideBlock,
+    PythonBlock as PythonBlock,
+    RandomBlock as RandomBlock,
+    RangeBlock as RangeBlock,
+    RedirectBlock as RedirectBlock,
+    ReplaceBlock as ReplaceBlock,
+    RequireBlock as RequireBlock,
+    ShortCutRedirectBlock as ShortCutRedirectBlock,
+    StopBlock as StopBlock,
+    StrfBlock as StrfBlock,
+    StrictVariableGetterBlock as StrictVariableGetterBlock,
+    SubstringBlock as SubstringBlock,
+    URLEncodeBlock as URLEncodeBlock,
+    UpperBlock as UpperBlock,
+    LowerBlock as LowerBlock,
+    CountBlock as CountBlock,
+    LengthBlock as LengthBlock,
+    CooldownBlock as CooldownBlock,
+)
+from .interface import (
+    Adapter as Adapter,
+    SimpleAdapter as SimpleAdapter,
+    Block as Block,
+    verb_required_block as verb_required_block,
+)
+from ._warnings import (
+    TagScriptEngineDeprecationWarning as TagScriptEngineDeprecationWarning,
+)
+from .exceptions import (
+    TagScriptError as TagScriptError,
+    WorkloadExceededError as WorkloadExceededError,
+    ProcessError as ProcessError,
+    EmbedParseError as EmbedParseError,
+    BadColourArgument as BadColourArgument,
+    StopError as StopError,
+    CooldownExceeded as CooldownExceeded,
+)
+from .interpreter import (
+    Interpreter as Interpreter,
+    AsyncInterpreter as AsyncInterpreter,
+    Context as Context,
+    Response as Response,
+    Node as Node,
+    build_node_tree as build_node_tree,
+)
+from .utils import (
+    truncate as truncate,
+    escape_content as escape_content,
+    maybe_await as maybe_await,
+)
+from .verb import (
+    Verb as Verb,
+)
+
+
+__all__: Tuple[str, ...] = (
+    "implicit_bool",
+    "helper_parse_if",
+    "helper_parse_list_if",
+    "helper_split",
+    "AllBlock",
+    "AnyBlock",
+    "AssignmentBlock",
+    "BlacklistBlock",
+    "BreakBlock",
+    "SequentialGather",
+    "CommandBlock",
+    "CooldownBlock",
+    "EmbedBlock",
+    "FiftyFiftyBlock",
+    "IfBlock",
+    "LooseVariableGetterBlock",
+    "MathBlock",
+    "OverrideBlock",
+    "PythonBlock",
+    "RandomBlock",
+    "RangeBlock",
+    "RedirectBlock",
+    "ReplaceBlock",
+    "RequireBlock",
+    "ShortCutRedirectBlock",
+    "StopBlock",
+    "StrfBlock",
+    "StrictVariableGetterBlock",
+    "SubstringBlock",
+    "URLEncodeBlock",
+    "UpperBlock",
+    "LowerBlock",
+    "CountBlock",
+    "LengthBlock",
+    "SafeObjectAdapter",
+    "StringAdapter",
+    "IntAdapter",
+    "FunctionAdapter",
+    "RedCommandAdapter",
+    "RedBotAdapter",
+    "AttributeAdapter",
+    "DiscordAttributeAdapter",
+    "UserAdapter",
+    "MemberAdapter",
+    "DMChannelAdapter",
+    "ChannelAdapter",
+    "GuildAdapter",
+    "RoleAdapter",
+    "DiscordObjectAdapter",
+    "Adapter",
+    "SimpleAdapter",
+    "Block",
+    "verb_required_block",
+    "TagScriptEngineDeprecationWarning",
+    "TagScriptError",
+    "WorkloadExceededError",
+    "ProcessError",
+    "EmbedParseError",
+    "BadColourArgument",
+    "StopError",
+    "CooldownExceeded",
+    "Interpreter",
+    "AsyncInterpreter",
+    "Context",
+    "Response",
+    "Node",
+    "build_node_tree",
+    "truncate",
+    "escape_content",
+    "maybe_await",
+    "Verb",
+    "__version__",
+    "VersionInfo",
+    "version_info",
+)
+
+
+__version__: Final[str] = "3.2.3"
+
+
+class VersionNamedTuple(NamedTuple):
+    major: int
+    minor: int
+    micro: int
+
+
+class VersionInfo(VersionNamedTuple):
+    """
+    Version information.
+
+    Attributes
+    ----------
+    major: int
+        Major version number.
+    minor: int
+        Minor version number.
+    micro: int
+        Micro version number.
+    """
+
+    __slots__: Tuple[str, ...] = ()
+
+    def __str__(self) -> str:
+        """
+        Returns a string representation of the version information.
+
+        Returns
+        -------
+        str
+            String representation of the version information.
+        """
+        return "{major}.{minor}.{micro}".format(**self._asdict())
+
+    @classmethod
+    def from_str(cls, version: str) -> "VersionInfo":
+        """
+        Returns a VersionInfo instance from a string.
+
+        Parameters
+        ----------
+        version: str
+            String representation of the version information.
+
+        Returns
+        -------
+        VersionInfo
+            Version information.
+        """
+        return cls(*map(int, version.split(".")))
+
+
+version_info: VersionInfo = VersionInfo.from_str(__version__)

advancedtagscript-3.2.3/TagScriptEngine/_warnings.py

@@ -0,0 +1,88 @@
+import warnings
+import functools
+from typing import Callable, Optional, Tuple, TypeVar
+from typing_extensions import ParamSpec
+
+
+_P = ParamSpec("_P")
+_T = TypeVar("_T")
+
+
+__all__: Tuple[str, ...] = (
+    "TagScriptEngineDeprecationWarning",
+    "TagScriptEngineAttributeRemovalWarning",
+)
+
+
+class TagScriptEngineAttributeRemovalWarning(Warning):
+    """A class for issuing removal warning for TagScriptEngine class attributes."""
+
+
+class TagScriptEngineDeprecationWarning(DeprecationWarning):
+    """A class for issuing deprecation warnings for TagScriptEngine modules."""
+
+
+def remove(
+    name: str, *, reason: Optional[str] = None, version: Optional[str] = None, level: int = 2
+) -> None:
+    warnings.warn(
+        "Removal: {name}.{reason}{version}".format(
+            name=name,
+            reason=" ({})".format(reason) if reason else "",
+            version=" -- Removal scheduled since version v{}".format(version) if version else "",
+        ),
+        category=TagScriptEngineAttributeRemovalWarning,
+        stacklevel=level,
+    )
+
+
+def removal(
+    *,
+    name: Optional[str] = None,
+    reason: Optional[str] = None,
+    version: Optional[str] = None,
+    level: int = 3,
+) -> Callable[[Callable[_P, _T]], Callable[_P, _T]]:
+    def decorator(func: Callable[_P, _T]) -> Callable[_P, _T]:
+        functools.wraps(func)
+
+        def wrapper(*args: _P.args, **kwargs: _P.kwargs) -> _T:
+            remove(name or func.__name__, reason=reason, version=version, level=level)
+            return func(*args, **kwargs)
+
+        return wrapper
+
+    return decorator
+
+
+def depricate(
+    name: str, *, reason: Optional[str] = None, version: Optional[str] = None, level: int = 2
+) -> None:
+    warnings.warn(
+        "Deprecated: {name}.{reason}{version}".format(
+            name=name,
+            reason=" ({})".format(reason) if reason else "",
+            version=" -- Deprecated since version v{}.".format(version) if version else "",
+        ),
+        category=TagScriptEngineDeprecationWarning,
+        stacklevel=level,
+    )
+
+
+def deprecated(
+    *,
+    name: Optional[str] = None,
+    reason: Optional[str] = None,
+    version: Optional[str] = None,
+    level: int = 3,
+) -> Callable[[Callable[_P, _T]], Callable[_P, _T]]:
+    def decorator(func: Callable[_P, _T]) -> Callable[_P, _T]:
+        functools.wraps(func)
+
+        def wrapper(*args: _P.args, **kwargs: _P.kwargs) -> _T:
+            depricate(name or func.__name__, reason=reason, version=version, level=level)
+            return func(*args, **kwargs)
+
+        return wrapper
+
+    return decorator