AdvancedTagScript 3.2.4__tar.gz → 3.2.5__tar.gz

{advancedtagscript-3.2.4 → advancedtagscript-3.2.5}/AdvancedTagScript.egg-info/PKG-INFO

@@ -1,15 +1,14 @@
 Metadata-Version: 2.4
 Name: AdvancedTagScript
-Version: 3.2.4
+Version: 3.2.5
 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
+License: CC-BY-4.0
 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
@@ -41,7 +40,7 @@ Dynamic: license-file
     <img src="https://img.shields.io/pypi/v/AdvancedTagScript" 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" />
+    <img src="https://readthedocs.org/projects/AdvancedTagScript/badge/?version=latest" alt="Documentation Status" />
 </a>
 <a href="https://pypi.python.org/pypi/AdvancedTagScript/">
     <img src="https://img.shields.io/pypi/dm/AdvancedTagScript" alt="PyPI - Downloads" />

{advancedtagscript-3.2.4 → advancedtagscript-3.2.5}/AdvancedTagScript.egg-info/SOURCES.txt

@@ -9,11 +9,6 @@ AdvancedTagScript.egg-info/SOURCES.txt
 AdvancedTagScript.egg-info/dependency_links.txt
 AdvancedTagScript.egg-info/requires.txt
 AdvancedTagScript.egg-info/top_level.txt
-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
@@ -34,13 +29,13 @@ 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/joinblock.py
 TagScriptEngine/block/loosevariablegetter.py
 TagScriptEngine/block/mathblock.py
 TagScriptEngine/block/randomblock.py

{advancedtagscript-3.2.4 → advancedtagscript-3.2.5}/PKG-INFO

@@ -1,15 +1,14 @@
 Metadata-Version: 2.4
 Name: AdvancedTagScript
-Version: 3.2.4
+Version: 3.2.5
 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
+License: CC-BY-4.0
 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
@@ -41,7 +40,7 @@ Dynamic: license-file
     <img src="https://img.shields.io/pypi/v/AdvancedTagScript" 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" />
+    <img src="https://readthedocs.org/projects/AdvancedTagScript/badge/?version=latest" alt="Documentation Status" />
 </a>
 <a href="https://pypi.python.org/pypi/AdvancedTagScript/">
     <img src="https://img.shields.io/pypi/dm/AdvancedTagScript" alt="PyPI - Downloads" />

{advancedtagscript-3.2.4 → advancedtagscript-3.2.5}/README.md

@@ -6,7 +6,7 @@
     <img src="https://img.shields.io/pypi/v/AdvancedTagScript" 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" />
+    <img src="https://readthedocs.org/projects/AdvancedTagScript/badge/?version=latest" alt="Documentation Status" />
 </a>
 <a href="https://pypi.python.org/pypi/AdvancedTagScript/">
     <img src="https://img.shields.io/pypi/dm/AdvancedTagScript" alt="PyPI - Downloads" />

{advancedtagscript-3.2.4 → advancedtagscript-3.2.5}/TagScriptEngine/__init__.py

@@ -24,6 +24,7 @@ from .block import (
     helper_parse_if as helper_parse_if,
     helper_parse_list_if as helper_parse_list_if,
     helper_split as helper_split,
+    easier_helper_split as easier_helper_split,
     AllowedMentionsBlock as AllowedMentionsBlock,
     AllBlock as AllBlock,
     AnyBlock as AnyBlock,
@@ -55,6 +56,8 @@ from .block import (
     CountBlock as CountBlock,
     LengthBlock as LengthBlock,
     CooldownBlock as CooldownBlock,
+    JoinBlock as JoinBlock,
+
 )
 from .interface import (
     Adapter as Adapter,
@@ -97,6 +100,8 @@ __all__: Tuple[str, ...] = (
     "helper_parse_if",
     "helper_parse_list_if",
     "helper_split",
+    "easier_helper_split",
+    "AllowedMentionsBlock",
     "AllBlock",
     "AnyBlock",
     "AssignmentBlock",
@@ -127,6 +132,8 @@ __all__: Tuple[str, ...] = (
     "LowerBlock",
     "CountBlock",
     "LengthBlock",
+    "JoinBlock",
+
     "SafeObjectAdapter",
     "StringAdapter",
     "IntAdapter",
@@ -170,7 +177,7 @@ __all__: Tuple[str, ...] = (
 )
 
 
-__version__: Final[str] = "3.2.4"
+__version__: Final[str] = "3.2.5"
 
 
 class VersionNamedTuple(NamedTuple):

{advancedtagscript-3.2.4 → advancedtagscript-3.2.5}/TagScriptEngine/block/__init__.py

@@ -89,6 +89,9 @@ from .count import (
     CountBlock as CountBlock,
     LengthBlock as LengthBlock,
 )
+from .joinblock import (
+    JoinBlock as JoinBlock,
+)
 
 __all__: Tuple[str, ...] = (
     "implicit_bool",
@@ -127,4 +130,5 @@ __all__: Tuple[str, ...] = (
     "LowerBlock",
     "CountBlock",
     "LengthBlock",
+    "JoinBlock",
 )

{advancedtagscript-3.2.4 → advancedtagscript-3.2.5}/TagScriptEngine/block/case.py

@@ -12,7 +12,7 @@ __all__: Tuple[str, ...] = ("UpperBlock", "LowerBlock")
 class UpperBlock(Block):
     """Converts the given text to uppercase.
 
-    **Usage:**  ``{upper([text]))}``
+    **Usage:**  ``{upper([text])}``
 
     **Aliases:**  ``uppercase, upper``
 
@@ -22,10 +22,10 @@ class UpperBlock(Block):
 
     **Examples:**  ::
 
-        The text is {lower(ThIs Is A TeXt)}!
+        The text is {upper(ThIs Is A TeXt)}!
         # The text is THIS IS A TEXT!
 
-        You have entered {lower({args})}!
+        You have entered {upper({args})}!
         # You have entered HELLO WORLD!
     """
 

advancedtagscript-3.2.5/TagScriptEngine/block/count.py

@@ -0,0 +1,78 @@
+from __future__ import annotations
+
+from typing import Optional, Tuple, cast
+
+from ..interface import verb_required_block
+from ..interpreter import Context
+
+
+__all__: Tuple[str, ...] = ("CountBlock", "LengthBlock")
+
+
+class CountBlock(verb_required_block(True, payload=True)):  # type: ignore
+    """
+    The count block counts occurrences of a substring within a message.
+    The search is case sensitive and includes overlapping substrings.
+
+    A payload (the message to search in) is **required**. Optionally,
+    pass the text to search for as a parameter. If no parameter is
+    provided, the block counts the number of words in the message
+    (spaces + 1).
+
+    **Usage:** ``{count([text]):<message>}``
+
+    **Aliases:** ``None``
+
+    **Payload:** ``message`` (required)
+
+    **Parameter:** ``text`` (optional, the substring to count)
+
+    **Examples:** ::
+
+        {count(Tag):TagScriptEngine}
+        # 1
+
+        {count(Tag):Tag Script Engine TagScriptEngine}
+        # 2
+
+        {count:hello world}
+        # 2 (word count: 1 space + 1)
+
+        {count(123)}
+        # Returns {count(123)} — rejected because no payload was provided
+    """
+
+    ACCEPTED_NAMES: Tuple[str, ...] = ("count",)
+
+    def process(self, ctx: Context) -> Optional[str]:
+        if ctx.verb.parameter:
+            payload: str = cast(str, ctx.verb.payload)
+            return str(payload.count(ctx.verb.parameter))
+        return str(cast(str, ctx.verb.payload).count(" ") + 1)
+
+
+class LengthBlock(verb_required_block(True, parameter=True)):  # type: ignore
+    """
+    The length block returns the character count of the given text.
+
+    **Usage:** ``{length(<text>)}``
+
+    **Aliases:** ``len``
+
+    **Payload:** ``None``
+
+    **Parameter:** ``text`` (required)
+
+    **Examples:** ::
+
+        {len(TagScriptEngine)}
+        # 15
+
+        {len(hello world)}
+        # 11
+    """
+
+    ACCEPTED_NAMES: Tuple[str, ...] = ("length", "len")
+
+    def process(self, ctx: Context) -> Optional[str]:
+        return str(len(ctx.verb.parameter)) if ctx.verb.parameter else "-1"

advancedtagscript-3.2.5/TagScriptEngine/block/joinblock.py

@@ -0,0 +1,43 @@
+from __future__ import annotations
+
+from typing import Optional, Tuple, cast
+
+from ..interface import verb_required_block
+from ..interpreter import Context
+
+
+__all__: Tuple[str, ...] = ("JoinBlock",)
+
+
+class JoinBlock(verb_required_block(False, payload=True, parameter=True)):  # type: ignore
+    """
+    The join block replaces every space in the payload with the parameter string.
+    These blocks only function in Tags.
+
+    The parameter must be set, even if it is an empty string.
+    Cannot use the symbols ``)`` or ``}`` as parameters.
+
+    **Usage:** ``{join(<string>):<payload>}``
+
+    **Aliases:** ``None``
+
+    **Payload:** payload
+
+    **Parameter:** string (required, can be empty)
+
+    **Examples:** ::
+
+        {join(_):hello friends}
+        # hello_friends
+
+        {join():an example sentence}
+        # anexamplesentence
+
+        {join(-):one two three}
+        # one-two-three
+    """
+
+    ACCEPTED_NAMES: Tuple[str, ...] = ("join",)
+
+    def process(self, ctx: Context) -> Optional[str]:
+        return cast(str, ctx.verb.payload).replace(" ", cast(str, ctx.verb.parameter))

{advancedtagscript-3.2.4 → advancedtagscript-3.2.5}/TagScriptEngine/block/replaceblock.py

@@ -53,16 +53,19 @@ class PythonBlock(verb_required_block(True, payload=True, parameter=True)):  # t
 
     The ``in`` alias checks if the parameter is anywhere in the payload.
 
-    ``contain`` strictly checks if the parameter is the payload, split by whitespace.
+    The ``contains`` alias strictly checks if the parameter is in the payload, split by whitespace.
 
-    ``index`` finds the location of the parameter in the payload, split by whitespace.
-    If the parameter string is not found in the payload, it returns 1.
+    The ``index`` alias finds the location/index of the parameter in the payload, split by whitespace.
+    If the parameter string is not found in the payload, it returns -1.
 
-    index is used to return the value of the string form the given list of
+    .. note::
+
+        Both ``contains`` and ``index`` perform **exact** matching on whitespace-split words.
+        For example, ``food`` will **not** match ``food.`` (with trailing punctuation).
 
     **Usage:** ``{in(<string>):<payload>}``
 
-    **Aliases:** ``index``, ``contains``
+    **Aliases:** ``in``, ``contains``, ``index``
 
     **Payload:** payload
 
@@ -80,12 +83,16 @@ class PythonBlock(verb_required_block(True, payload=True, parameter=True)):  # t
         {contains(mute):How does it feel to be muted?}
         # false
         {contains(muted?):How does it feel to be muted?}
-        # false
+        # true
 
         {index(food):I love to eat food. everyone does.}
-        # 4
-        {index(pie):I love to eat food. everyone does.}
-        # -1
+        # -1 # because of the period. "food" != "food."
+        {index(food):I love to eat food everyone does}
+        # 4 # because "food" is the 4th word in the payload
+        {index(love):I love to eat food}
+        # 1 # because "love" is the 2nd word in the payload
+        {index(pie):I love to eat food}
+        # -1 # because "pie" is not in the payload
     """
 
     def will_accept(self, ctx: Context) -> bool:  # type: ignore

{advancedtagscript-3.2.4 → advancedtagscript-3.2.5}/TagScriptEngine/block/stopblock.py

@@ -24,7 +24,7 @@ class StopBlock(verb_required_block(True, parameter=True)):  # type: ignore
 
     **Parameter:** bool
 
-    **Example:** ::
+    **Examples:** ::
 
         {stop({args}==):You must provide arguments for this tag.}
         # enforces providing arguments for a tag

{advancedtagscript-3.2.4 → advancedtagscript-3.2.5}/TagScriptEngine/block/strf.py

@@ -16,7 +16,7 @@ class StrfBlock(Block):
     Two types of timestamps are supported: ISO and epoch.
     If a timestamp isn't passed, the current UTC time is used.
 
-    Invoking this block with `unix` will return the current Unix timestamp.
+    Invoking this block with ``unix`` will return the current Unix timestamp.
 
     **Usage:** ``{strf([timestamp]):<format>}``
 

{advancedtagscript-3.2.4 → advancedtagscript-3.2.5}/TagScriptEngine/block/urlencodeblock.py

@@ -30,8 +30,8 @@ class URLEncodeBlock(verb_required_block(True, payload=True)):  # type: ignore
 
         # the following tagscript can be used to search up tag blocks
         # assume {args} = "command block"
-        # <https://seina-cogs.readthedocs.io/en/latest/search.html?q={urlencode(+):{args}}&check_keywords=yes&area=default>
-        # <https://seina-cogs.readthedocs.io/en/latest/search.html?q=command+block&check_keywords=yes&area=default>
+        # <https://cool-cogs.readthedocs.io/en/latest/search.html?q={urlencode(+):{args}}&check_keywords=yes&area=default>
+        # <https://cool-cogs.readthedocs.io/en/latest/search.html?q=command+block&check_keywords=yes&area=default>
     """
 
     ACCEPTED_NAMES: Tuple[str, ...] = ("urlencode",)

{advancedtagscript-3.2.4 → advancedtagscript-3.2.5}/setup.cfg

@@ -7,7 +7,6 @@ author_email = coolaid@duskybot.xyz
 classifiers = 
 	Development Status :: 5 - Production/Stable
 	Intended Audience :: Developers
-	License :: Freely Distributable
 	Natural Language :: English
 	Operating System :: OS Independent
 	Programming Language :: Python :: 3.8
@@ -19,7 +18,7 @@ classifiers =
 	Topic :: Software Development :: Libraries :: Python Modules
 	Topic :: Utilities
 	Typing :: Typed
-license = Creative Commons Attribution 4.0 International License
+license = CC-BY-4.0
 license_file = LICENSE
 description = An easy drop in user-provided Templating system.
 long_description = file: README.md

advancedtagscript-3.2.4/TagScriptEngine/block/comment.py

@@ -1,29 +0,0 @@
-from typing import Optional, Tuple
-from ..interface import Block
-from ..interpreter import Context
-
-
-class CommentBlock(Block):
-    """
-    The comment block is just for comments, it will not be parsed,
-    however it will be removed from your tag's output.
-
-    **Usage:** ``{comment([other]):[text]}``
-
-    **Aliases:** /, Comment, comment, //, #
-
-    **Payload:** ``text``
-
-    **Parameter:** ``other``
-
-    .. tagscript::
-
-        {#:Comment!}
-
-        {Comment(Something):Comment!}
-    """
-
-    ACCEPTED_NAMES: Tuple[str, ...] = ("/", "Comment", "comment", "//", "#")
-
-    def process(self, ctx: Context) -> Optional[str]:
-        return ""

advancedtagscript-3.2.4/TagScriptEngine/block/count.py

@@ -1,68 +0,0 @@
-from __future__ import annotations
-
-from typing import Optional, Tuple, cast
-
-from ..interface import verb_required_block
-from ..interpreter import Context
-
-
-__all__: Tuple[str, ...] = ("CountBlock", "LengthBlock")
-
-
-class CountBlock(verb_required_block(True, payload=True)):  # type: ignore
-    """
-    The count block will count how much of text is in message.
-    This is case sensitive and will include substrings, if you
-    don't provide a parameter, it will count the spaces in the
-    message.
-
-    **Usage:** ``{count([text]):<message>}``
-
-    **Aliases:** ``None``
-
-    **Payload:** ``message``
-
-    **Parameter:** text
-
-    .. tagscript::
-        {count(Tag):TagScriptEngine}
-        # 1
-
-        {count(Tag): Tag Script Engine TagScriptEngine}
-        # 2
-    """
-
-    ACCEPTED_NAMES: Tuple[str, ...] = ("count",)
-
-    def process(self, ctx: Context) -> Optional[str]:
-        if ctx.verb.parameter:
-            payload: str = cast(str, ctx.verb.payload)
-            return str(payload.count(ctx.verb.parameter))
-        return str(len(cast(str, ctx.verb.payload)) + 1)
-
-
-class LengthBlock(verb_required_block(True, payload=True)):  # type: ignore
-    """
-    The length block will check the length of the given String.
-    If a parameter is passed in, the block will check the length
-    based on what you passed in, w for word, s for spaces.
-    If you provide an invalid parameter, the block will return -1.
-
-    **Usage:** ``{length(<text>)}``
-
-    **Aliases:** ``len``
-
-    **Payload:** None
-
-    **Parameter:** ``text``
-
-    .. tagscript::
-
-        {len("TagScriptEngine")}
-        15
-    """
-
-    ACCEPTED_NAMES: Tuple[str, ...] = ("length", "len")
-
-    def process(self, ctx: Context) -> Optional[str]:
-        return str(len(ctx.verb.parameter)) if ctx.verb.parameter else "-1"