Merge pull request #233 from davidhozic/develop

v2.3 prep

Author: davidhozic

.github/workflows/python-tests.yml

@@ -1,4 +1,4 @@
-name: Run auto tests
+name: Self-Test
 
 on:
   push:
@@ -15,22 +15,33 @@ jobs:
       fail-fast: false
       matrix:
         python-version: ["3.8", "3.10"]
-
     steps:
     - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v3
       with:
         python-version: ${{ matrix.python-version }}
+    - name: Disable initramfs update
+      run: sudo sed -i 's/yes/no/g' /etc/initramfs-tools/update-initramfs.conf
+    - name: Disable man-db update
+      run: sudo rm -f /var/lib/man-db/auto-update
     - name: Install dependencies
       run: |
         sudo apt update
         sudo apt install -y ffmpeg
         python -m pip install --upgrade pip
         python -m pip install .[all]
         python -m pip install .[testing]
-    - name: Test with pytest
+    - name: Test version compatibility
+      env:
+        DISCORD_TOKEN: ${{secrets.DATT}}
+      if: ${{ matrix.python-version != 3.8 }}
+      run: |
+        pytest -v testing/test_period_dynamic.py  
+    - name: Test all
       env:
         DISCORD_TOKEN: ${{secrets.DATT}}
+      if: ${{ matrix.python-version == 3.8 }}
       run: |
         pytest -v
+      

.gitignore

@@ -2,4 +2,5 @@
 settings.json
 dist/**
 build**
-**.egg-info
+**.egg-info
+src/test.py

Examples/Automatic Generation/autochannel.py

@@ -0,0 +1,24 @@
+from datetime import timedelta
+import daf
+import asyncio
+
+
+async def main():
+    await daf.add_object(
+        daf.GUILD(
+            snowflake=123456789,
+            messages=[
+                daf.TextMESSAGE(
+                    None, timedelta(seconds=5), "Hello World",
+                    channels=daf.message.AutoCHANNEL("shill", exclude_pattern="shill-[7-9]")
+                )
+            ],
+            logging=True
+        )
+    )
+
+
+daf.run(
+    token="SomeServerTokenHere",
+    user_callback=main,
+)

Examples/Automatic Generation/autoguild.py

@@ -0,0 +1,44 @@
+from datetime import timedelta
+import daf
+
+
+# STATIC DEFINITION
+STATIC_AUTOGUILD_LIST = [
+    daf.guild.AutoGUILD(
+        include_pattern="NFT-Dragons", # Regex pattern of guild names that should be included
+        exclude_pattern="NonFunctionalTesticle",   # Regex pattern of guild names that should be excluded
+        remove_after=None, # Never stop automatically managing guilds
+        messages=[ # Pre-include messages
+            daf.message.TextMESSAGE(None, timedelta(seconds=5), "Buy our NFT today!",daf.guild.AutoCHANNEL("shill", "promo", timedelta(seconds=60)))
+        ], 
+        logging=True, # The generated GUILD objects will have logging enabled
+        interval=timedelta(hours=1) # Scan for new guilds in a period of one hour
+    )
+]
+
+
+async def main():
+    # DYNAMIC DEFINITION/ADDITION
+    auto_guild = daf.guild.AutoGUILD(
+                    include_pattern="David", # Regex pattern of guild names that should be included
+                    exclude_pattern="NFT-Python",   # Regex pattern of guild names that should be excluded
+                    remove_after=None, # Never stop automatically managing guilds
+                    messages=[], # Pre-include messages
+                    logging=True, # The generated GUILD objects will have logging enabled
+                    interval=timedelta(hours=1) # Scan for new guilds in a period of one hour
+                )
+
+    await daf.add_object(auto_guild)
+    await auto_guild.add_message(
+        daf.message.TextMESSAGE(
+            None, timedelta(seconds=5), "Buy our NFT today!",
+            daf.guild.AutoCHANNEL("shill", "promo", timedelta(seconds=60)))
+    )
+
+
+
+daf.run(
+    token="SomeServerTokenHere",
+    user_callback=main,
+    server_list=STATIC_AUTOGUILD_LIST
+)

docs/scripts/generate_autodoc.py

@@ -36,8 +36,6 @@
 ========================
 .. autoclass:: {object_path}
     :members:
-
-    {properties}
 """
 
 AUTO_ENUM_TEMPLATE =\
@@ -100,13 +98,7 @@
             if isinstance(item, EnumMeta):
                 export_c_items += AUTO_ENUM_TEMPLATE.format(object_name=object_name, object_path=object_path) + "\n"
             else:
-                properties = []
-                for name in dir(item):
-                    attr = getattr(item, name)
-                    if isinstance(attr, property):
-                        properties.append(f".. autoproperty:: {object_path}.{name}")
-
-                export_c_items += AUTO_CLASS_TEMPLATE.format(object_name=object_name, object_path=object_path, properties="\n\n    ".join(properties)) + "\n"
+                export_c_items += AUTO_CLASS_TEMPLATE.format(object_name=object_name, object_path=object_path) + "\n"
 
 
     if export_f_items:

docs/source/changelog.rst

@@ -32,6 +32,24 @@ Glossary
 Releases
 ----------------------
 
+v2.3
+=============
+- |BREAK_CH| Removed ``exceptions`` module, meaning that there are no DAFError derived exceptions from this version on.
+  They are replaced with build-in Python exceptions.
+- Automatic scheme generation and management:
+
+  - :class:`daf.guild.AutoGUILD` class for auto-managed GUILD objects.
+  - :class:`daf.message.AutoCHANNEL` class for auto-managed channels inside message.
+
+- Debug levels:
+
+  - Added deprecated to :class:`~daf.logging.tracing.TraceLEVELS`.
+  - Changed the :func:`daf.core.run`'s debug parameter to accept a value from :class:`~daf.logging.tracing.TraceLEVELS`, to dictate
+    what level trace should be displayed.
+
+- :ref:`Messages` objects period automatically increases if it is less than slow-mode timeout.
+- The :ref:`data_function`'s input function can now also be async.
+
 v2.2
 ===========
 - ``user_callback`` parameter for function :func:`daf.core.run` can now also be a regular function instead of just ``async``.

docs/source/classes.rst

@@ -1,4 +1,3 @@
-
 ===============================
 Classes
 ===============================
@@ -22,128 +21,61 @@ LoggerBASE
 .. autoclass:: daf.logging.LoggerBASE
     :members:
 
-    
-
 
 LoggerCSV
 ========================
 .. autoclass:: daf.logging.LoggerCSV
     :members:
 
-    
-
 
 LoggerJSON
 ========================
 .. autoclass:: daf.logging.LoggerJSON
     :members:
 
-    
-
 
 LoggerSQL
 ========================
 .. autoclass:: daf.logging.sql.LoggerSQL
     :members:
 
-    
-
 
 ----------------------------
-Exceptions
+Message data types
 ----------------------------
 
-DAFError
+EMBED
 ========================
-.. autoclass:: daf.exceptions.DAFError
-    :members:
-
-    
+.. autoclass:: daf.dtypes.EMBED
 
 
-DAFNotFoundError
+FILE
 ========================
-.. autoclass:: daf.exceptions.DAFNotFoundError
+.. autoclass:: daf.dtypes.FILE
     :members:
 
-    
-
 
-DAFSQLError
+AUDIO
 ========================
-.. autoclass:: daf.exceptions.DAFSQLError
+.. autoclass:: daf.dtypes.AUDIO
     :members:
 
-    
-.. glossary::
-
-    DAF_SNOWFLAKE_NOT_FOUND:
-        Value: 1
-
-        Info: Guild with specified snowflake was not found (or user).
-
-    DAF_USER_CREATE_DM:
-        Value: 2
-
-        Info: Was unable to create DM with user (probably user not found).
-
-    DAF_YOUTUBE_STREAM_ERROR:
-        Value: 3
-
-        Info: The given youtube link could not be streamed (AUDIO, VoiceMESSAGE).
-
-    DAF_FILE_NOT_FOUND:
-        Value: 4
-
-        Info: The given file was not found.
-
-    DAF_SQL_CREATE_TABLES_ERROR:
-        Value: 5
-
-        Info: Unable to create all the tables.
-
-    DAF_SQL_BEGIN_ENGINE_ERROR:
-        Value: 7
-
-        Info: Unable to start engine.
-
-    DAF_SQL_CR_LT_VALUES_ERROR:
-        Value: 8
-
-        Info: Unable to create lookuptables' rows.
-
-    DAF_SQL_SAVE_LOG_ERROR:
-        Value: 12
-
-        Info: Unable to save the log to SQL
-
 
 ----------------------------
-Message data types
+Automatic generation
 ----------------------------
 
-EMBED
+AutoCHANNEL
 ========================
-.. autoclass:: daf.dtypes.EMBED
+.. autoclass:: daf.message.AutoCHANNEL
     :members:
-    :exclude-members: Colour, Color
 
 
-FILE
+AutoGUILD
 ========================
-.. autoclass:: daf.dtypes.FILE
+.. autoclass:: daf.guild.AutoGUILD
     :members:
 
-    
-
-
-AUDIO
-========================
-.. autoclass:: daf.dtypes.AUDIO
-    :members:
-
-    
-
 
 ----------------------------
 Messages
@@ -154,24 +86,18 @@ TextMESSAGE
 .. autoclass:: daf.message.TextMESSAGE
     :members:
 
-    .. autoproperty:: daf.message.TextMESSAGE.created_at
-
 
 DirectMESSAGE
 ========================
 .. autoclass:: daf.message.DirectMESSAGE
     :members:
 
-    .. autoproperty:: daf.message.DirectMESSAGE.created_at
-
 
 VoiceMESSAGE
 ========================
 .. autoclass:: daf.message.VoiceMESSAGE
     :members:
 
-    .. autoproperty:: daf.message.VoiceMESSAGE.created_at
-
 
 ----------------------------
 Guilds
@@ -182,21 +108,9 @@ GUILD
 .. autoclass:: daf.guild.GUILD
     :members:
 
-    .. autoproperty:: daf.guild.GUILD.created_at
-
-    .. autoproperty:: daf.guild.GUILD.messages
-
-    .. autoproperty:: daf.guild.GUILD.snowflake
-
 
 USER
 ========================
 .. autoclass:: daf.guild.USER
     :members:
 
-    .. autoproperty:: daf.guild.USER.created_at
-
-    .. autoproperty:: daf.guild.USER.messages
-
-    .. autoproperty:: daf.guild.USER.snowflake
-

docs/source/conf.py

@@ -28,8 +28,7 @@
 elif readthedocs_release is not None:
     version = readthedocs_release
 else:
-    with open("../../version.txt", "r", encoding="utf-8") as rf:
-        version = rf.read().strip()
+    version = "v0.0.1"
 
 
 # -- General configuration ---------------------------------------------------
@@ -71,12 +70,16 @@
 autodoc_typehints_format = "short"
 
 
+developement_build = os.environ.get("DOC_DEVELOPMENT", default="False")
+developement_build = True if developement_build == "True" else False
+
 autodoc_default_options = {
-    'members': True,
     'member-order': 'bysource',
+    "private-members": developement_build
 }
 
 
+
 # Intersphinx
 intersphinx_mapping = {
     'PyCord': ("https://docs.pycord.dev/en/stable/", None)