Update 0.8.7

Merge pull request #52 from romanin-rf/dev
romanin-rf · Dec 21, 2023 · e5f4012 · e5f4012
2 parents 98a7129 + d0ba96d
commit e5f4012
Show file tree

Hide file tree

Showing 123 changed files with 31,725 additions and 1,683 deletions.
diff --git a/.github/workflows/python-app.yml b/.github/workflows/python-app.yml
@@ -1,17 +1,11 @@
-# This workflow will install Python dependencies, run tests and lint with a single version of Python
-# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
-
 name: SeaPlayer
-
 on:
   push:
     branches: [ "main" ]
   pull_request:
     branches: [ "main" ]
-
 permissions:
   contents: read
-
 jobs:
   build:
     runs-on: ubuntu-latest

diff --git a/.gitmodules b/.gitmodules
diff --git a/changelog.md b/changelog.md
@@ -3,6 +3,7 @@
 
 | Version | Date | Tag | Changelog |
 | ------- | ---- | --- | --------- |
+| [v0.8.7](https://github.com/romanin-rf/SeaPlayer/releases/tag/v0.8.7) | 21.12.2023 | **STABLE** | - Added comments for documentation (not fully)<br>- Added API documentation (not fully)<br>- Removed `secrets`<br>- Fixed documentation |
 | [v0.8.6](https://github.com/romanin-rf/SeaPlayer/releases/tag/v0.8.6) | 17.12.2023 | **STABLE** | - Added new methods for `seaplayer.plug.pluginloader.PluginLoaderConfigManager`: **remove_plugin** & **remove_plugin_by_name_id**<br>- Added new command for `seaplug`: **unload**<br>- Added version message for `seaplug`<br>- Fixed typing for: `seaplayer.plug.pluginloader.PluginLoader.search_plugins_paths` & `seaplayer.plug.pluginloader.PluginLoader.aio_search_plugins_paths`<br>- Replaced option `--recreate` with `--overwrite` in `seaplayer.plug.cli.cli.creating`<br>- Replaced option `--rewrite` with `--overwrite` in `seaplayer.plug.cli.cli.loading` |
 | [v0.8.5](https://github.com/romanin-rf/SeaPlayer/releases/tag/v0.8.5) | 16.12.2023 | **STABLE** | - Added support for **python3.8**<br>- Added `on_ready` abstract methods for plugins<br>- Added new widgets: `PopUpWindow`, `WaitButton`<br>- Fixed method `add_sounds_to_list`<br>- Fixed `seaplayer.plug.cli`<br>- Fixed `build.py`<br>- Updated all child custom modules |
 | [v0.8.4](https://github.com/romanin-rf/SeaPlayer/releases/tag/v0.8.4) | 11.12.2023 | **DEPRECATED** | - Added widgets: `Rheostat`, `ClickableLabel`<br>- Added widget: Rheostat<br>- Added a new widget: `PopUp`<br>- Fixed all language<br>- More attempts to make `Confiturate` screen clearer<br>- Moved all `CSS` from `objects.tcss` to `DEFAULT_CSS` separately for each widget |

diff --git a/docs-source/docs/_templates/python/material/_base/docstring/admonition.html b/docs-source/docs/_templates/python/material/_base/docstring/admonition.html
@@ -0,0 +1,5 @@
+{{ log.debug("Rendering admonition") }}
+<details class="{{ section.value.kind }}" open>
+  <summary>{{ section.title|convert_markdown(heading_level, html_id, strip_paragraph=True) }}</summary>
+  {{ section.value.contents|convert_markdown(heading_level, html_id) }}
+</details>
diff --git a/docs-source/docs/_templates/python/material/_base/docstring/attributes.html b/docs-source/docs/_templates/python/material/_base/docstring/attributes.html
@@ -0,0 +1,78 @@
+{{ log.debug("Rendering attributes section") }}
+{% if config.docstring_section_style == "table" %}
+  {% block table_style %}
+  <h5>{{ section.title or "Attributes" }}</h5>
+  <table>
+    <thead>
+      <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th>Description</th>
+      </tr>
+    </thead>
+    <tbody>
+      {% for attribute in section.value %}
+        <tr>
+          <td><code>{{ attribute.name }}</code></td>
+          <td>
+            {% if attribute.annotation %}
+              {% with expression = attribute.annotation %}
+                <code>{% include "expression.html" with context %}</code>
+              {% endwith %}
+            {% endif %}
+          </td>
+          <td>{{ attribute.description|convert_markdown(heading_level, html_id) }}</td>
+        </tr>
+      {% endfor %}
+    </tbody>
+  </table>
+  {% endblock table_style %}
+{% elif config.docstring_section_style == "list" %}
+  {% block list_style %}
+  <p>{{ section.title or "Attributes:" }}</p>
+  <ul>
+    {% for attribute in section.value %}
+      <li class="field-body">
+        <b>{{ attribute.name }}</b>
+        {% if attribute.annotation %}
+          {% with expression = attribute.annotation %}
+            (<code>{% include "expression.html" with context %}</code>)
+          {% endwith %}
+        {% endif %}
+        – {{ attribute.description|convert_markdown(heading_level, html_id) }}
+      </li>
+    {% endfor %}
+  </ul>
+  {% endblock list_style %}
+{% elif config.docstring_section_style == "spacy" %}
+  {% block spacy_style %}
+  <table>
+    <thead>
+      <tr>
+        <th><b>{{ (section.title or "ATTRIBUTE").rstrip(":").upper() }}</b></th>
+        <th><b>DESCRIPTION</b></th>
+      </tr>
+    </thead>
+    <tbody>
+      {% for attribute in section.value %}
+        <tr>
+          <td><code>{{ attribute.name }}</code></td>
+          <td class="doc-attribute-details">
+            {{ attribute.description|convert_markdown(heading_level, html_id) }}
+            <p>
+              {% if attribute.annotation %}
+                <span class="doc-attribute-annotation">
+                  <b>TYPE:</b>
+                  {% with expression = attribute.annotation %}
+                    <code>{% include "expression.html" with context %}</code>
+                  {% endwith %}
+                </span>
+              {% endif %}
+            </p>
+          </td>
+        </tr>
+      {% endfor %}
+    </tbody>
+  </table>
+  {% endblock spacy_style %}
+{% endif %}
diff --git a/docs-source/docs/_templates/python/material/_base/docstring/parameters.html b/docs-source/docs/_templates/python/material/_base/docstring/parameters.html
@@ -0,0 +1,96 @@
+{{ log.debug("Rendering parameters section") }}
+{% if config.docstring_section_style == "table" %}
+  {% block table_style %}
+  <h5>{{ section.title or "Parameters" }}</h5>
+  <table>
+    <thead>
+      <tr>
+        <th>Parameter</th>
+        <th>Default</th>
+        <th>Description</th>
+      </tr>
+    </thead>
+    <tbody>
+      {% for parameter in section.value %}
+        <tr>
+          <td>
+            <strong><code>{{ parameter.name }}</code></strong>
+            <br>
+            {% if parameter.annotation %}
+              {% with expression = parameter.annotation %}
+                <code>{% include "expression.html" with context %}</code>
+              {% endwith %}
+            {% endif %}
+          </td>
+          <td>
+            {% if parameter.default %}
+            {% with expression = parameter.default %}
+            <code>{% include "expression.html" with context %}</code>
+            {% endwith %}
+            {% else %}
+            <em>required</em>
+            {% endif %}
+          </td>
+          <td>{{ parameter.description|convert_markdown(heading_level, html_id) }}</td>
+        </tr>
+      {% endfor %}
+    </tbody>
+  </table>
+  {% endblock table_style %}
+{% elif config.docstring_section_style == "list" %}
+  {% block list_style %}
+  <p>{{ section.title or "Parameters:" }}</p>
+  <ul>
+    {% for parameter in section.value %}
+      <li class="field-body">
+        <b>{{ parameter.name }}</b>
+        {% if parameter.annotation %}
+          {% with expression = parameter.annotation %}
+            (<code>{% include "expression.html" with context %}</code>)
+          {% endwith %}
+        {% endif %}
+        – {{ parameter.description|convert_markdown(heading_level, html_id) }}
+      </li>
+    {% endfor %}
+  </ul>
+  {% endblock list_style %}
+{% elif config.docstring_section_style == "spacy" %}
+  {% block spacy_style %}
+  <table>
+    <thead>
+      <tr>
+        <th><b>{{ (section.title or "PARAMETER").rstrip(":").upper() }}</b></th>
+        <th><b>DESCRIPTION</b></th>
+      </tr>
+    </thead>
+    <tbody>
+      {% for parameter in section.value %}
+        <tr>
+          <td><code>{{ parameter.name }}</code></td>
+          <td class="doc-param-details">
+            {{ parameter.description|convert_markdown(heading_level, html_id) }}
+            <p>
+              {% if parameter.annotation %}
+                <span class="doc-param-annotation">
+                  <b>TYPE:</b>
+                  {% with expression = parameter.annotation %}
+                    <code>{% include "expression.html" with context %}</code>
+                  {% endwith %}
+                </span>
+              {% endif %}
+              {% if parameter.default %}
+                <span class="doc-param-default">
+                  <b>DEFAULT:</b>
+                  {% with expression = parameter.default %}
+                    <code>{% include "expression.html" with context %}</code>
+                  {% endwith %}
+                </span>
+              {% endif %}
+            </p>
+          </td>
+        </tr>
+      {% endfor %}
+    </tbody>
+  </table>
+  {% endblock spacy_style %}
+{% endif %}
diff --git a/docs-source/docs/_templates/python/material/_base/docstring/raises.html b/docs-source/docs/_templates/python/material/_base/docstring/raises.html
@@ -0,0 +1,72 @@
+{{ log.debug("Rendering raises section") }}
+{% if config.docstring_section_style == "table" %}
+  {% block table_style %}
+  <h5>{{ section.title or "Raises" }}</h5>
+  <table>
+    <thead>
+      <tr>
+        <th>Type</th>
+        <th>Description</th>
+      </tr>
+    </thead>
+    <tbody>
+      {% for raises in section.value %}
+        <tr>
+          <td>
+            {% if raises.annotation %}
+              {% with expression = raises.annotation %}
+                <code>{% include "expression.html" with context %}</code>
+              {% endwith %}
+            {% endif %}
+          </td>
+          <td>{{ raises.description|convert_markdown(heading_level, html_id) }}</td>
+        </tr>
+      {% endfor %}
+    </tbody>
+  </table>
+  {% endblock table_style %}
+{% elif config.docstring_section_style == "list" %}
+  {% block list_style %}
+  <p>{{ section.title or "Raises:" }}</p>
+  <ul>
+    {% for raises in section.value %}
+      <li class="field-body">
+        {% if raises.annotation %}
+          {% with expression = raises.annotation %}
+            <code>{% include "expression.html" with context %}</code>
+          {% endwith %}
+          –
+        {% endif %}
+        {{ raises.description|convert_markdown(heading_level, html_id) }}
+      </li>
+    {% endfor %}
+  </ul>
+  {% endblock list_style %}
+{% elif config.docstring_section_style == "spacy" %}
+  {% block spacy_style %}
+  <table>
+    <thead>
+      <tr>
+        <th><b>{{ (section.title or "RAISES").rstrip(":").upper() }}</b></th>
+        <th><b>DESCRIPTION</b></th>
+      </tr>
+    </thead>
+    <tbody>
+      {% for raises in section.value %}
+        <tr>
+          <td>
+            <span class="doc-raises-annotation">
+              {% with expression = raises.annotation %}
+                <code>{% include "expression.html" with context %}</code>
+              {% endwith %}
+            </span>
+          </td>
+          <td class="doc-raises-details">
+            {{ raises.description|convert_markdown(heading_level, html_id) }}
+          </td>
+        </tr>
+      {% endfor %}
+    </tbody>
+  </table>
+  {% endblock spacy_style %}
+{% endif %}
diff --git a/docs-source/docs/_templates/python/material/_base/docstring/returns.html b/docs-source/docs/_templates/python/material/_base/docstring/returns.html
@@ -0,0 +1,91 @@
+{{ log.debug("Rendering returns section") }}
+{% if config.docstring_section_style == "table" %}
+  {% block table_style %}
+  {% set name_column = section.value|selectattr("name")|any %}
+  <h5>{{ section.title or "Returns" }}</h5>
+  <table>
+    <thead>
+      <tr>
+        {% if name_column %}<th>Name</th>{% endif %}
+        <th>Type</th>
+        <th>Description</th>
+      </tr>
+    </thead>
+    <tbody>
+      {% for returns in section.value %}
+        <tr>
+          {% if name_column %}<td>{% if returns.name %}<code>{{ returns.name }}</code>{% endif %}</td>{% endif %}
+          <td>
+            {% if returns.annotation %}
+              {% with expression = returns.annotation %}
+                <code>{% include "expression.html" with context %}</code>
+              {% endwith %}
+            {% endif %}
+          </td>
+          <td>{{ returns.description|convert_markdown(heading_level, html_id) }}</td>
+        </tr>
+      {% endfor %}
+    </tbody>
+  </table>
+  {% endblock table_style %}
+{% elif config.docstring_section_style == "list" %}
+  {% block list_style %}
+  <p>{{ section.title or "Returns:" }}</p>
+  <ul>
+    {% for returns in section.value %}
+      <li class="field-body">
+        {% if returns.name %}<b>{{ returns.name }}</b>{% endif %}
+        {% if returns.annotation %}
+          {% with expression = returns.annotation %}
+            {% if returns.name %}({% endif %}
+            <code>{% include "expression.html" with context %}</code>
+            {% if returns.name %}){% endif %}
+          {% endwith %}
+        {% endif %}
+        – {{ returns.description|convert_markdown(heading_level, html_id) }}
+      </li>
+    {% endfor %}
+  </ul>
+  {% endblock list_style %}
+{% elif config.docstring_section_style == "spacy" %}
+  {% block spacy_style %}
+  <table>
+    <thead>
+      <tr>
+        <th><b>{{ (section.title or "RETURNS").rstrip(":").upper() }}</b></th>
+        <th><b>DESCRIPTION</b></th>
+      </tr>
+    </thead>
+    <tbody>
+      {% for returns in section.value %}
+        <tr>
+          <td>
+            {% if returns.name %}
+              <code>{{ returns.name }}</code>
+            {% elif returns.annotation %}
+              <span class="doc-returns-annotation">
+                {% with expression = returns.annotation %}
+                  <code>{% include "expression.html" with context %}</code>
+                {% endwith %}
+              </span>
+            {% endif %}
+          </td>
+          <td class="doc-returns-details">
+            {{ returns.description|convert_markdown(heading_level, html_id) }}
+            {% if returns.name and returns.annotation %}
+              <p>
+                <span class="doc-returns-annotation">
+                  <b>TYPE:</b>
+                  {% with expression = returns.annotation %}
+                    <code>{% include "expression.html" with context %}</code>
+                  {% endwith %}
+                </span>
+              </p>
+            {% endif %}
+          </td>
+        </tr>
+      {% endfor %}
+    </tbody>
+  </table>
+  {% endblock spacy_style %}
+{% endif %}
diff --git a/docs-source/docs/api/codecbase.md b/docs-source/docs/api/codecbase.md
@@ -0,0 +1 @@
+::: seaplayer.codeсbase
diff --git a/docs-source/docs/api/config.md b/docs-source/docs/api/config.md
@@ -0,0 +1 @@
+::: seaplayer.config
diff --git a/docs-source/docs/api/exceptions.md b/docs-source/docs/api/exceptions.md
@@ -0,0 +1 @@
+::: seaplayer.exceptions
diff --git a/docs-source/docs/api/index.md b/docs-source/docs/api/index.md
@@ -0,0 +1,3 @@
+# Welcome to SeaPlayer API
+
+Пусто
diff --git a/docs-source/docs/api/languages.md b/docs-source/docs/api/languages.md
@@ -0,0 +1 @@
+::: seaplayer.languages
diff --git a/docs-source/docs/api/pluginbase.md b/docs-source/docs/api/pluginbase.md
@@ -0,0 +1 @@
+::: seaplayer.plug.pluginbase
diff --git a/docs-source/docs/api/pluginloader.md b/docs-source/docs/api/pluginloader.md
@@ -0,0 +1 @@
+::: seaplayer.plug.pluginloader