Clean slate.
Some checks are pending
Tests / tests 3.9 / macos-latest (push) Waiting to run
Tests / mypy 3.6 / ubuntu-latest (push) Waiting to run
Tests / tests 3.6 / ubuntu-latest (push) Waiting to run
Tests / mypy 3.7 / ubuntu-latest (push) Waiting to run
Tests / tests 3.7 / ubuntu-latest (push) Waiting to run
Tests / docs-build 3.8 / ubuntu-latest (push) Waiting to run
Tests / mypy 3.8 / ubuntu-latest (push) Waiting to run
Tests / tests 3.8 / ubuntu-latest (push) Waiting to run
Tests / mypy 3.9 / ubuntu-latest (push) Waiting to run
Tests / pre-commit 3.9 / ubuntu-latest (push) Waiting to run
Tests / safety 3.9 / ubuntu-latest (push) Waiting to run
Tests / tests 3.9 / ubuntu-latest (push) Waiting to run
Tests / typeguard 3.9 / ubuntu-latest (push) Waiting to run
Tests / xdoctest 3.9 / ubuntu-latest (push) Waiting to run
Tests / tests 3.9 / windows-latest (push) Waiting to run
Tests / coverage (push) Blocked by required conditions

Signed-off-by: Cliff Hill <xlorep@darkhelm.org>
This commit is contained in:
2025-03-08 12:55:44 -05:00
parent e90abe3698
commit 57e051b45c
45 changed files with 0 additions and 5395 deletions

View File

@@ -1,11 +0,0 @@
{
"_template": "gh:cjolowicz/cookiecutter-hypermodern-python",
"author": "Cliff Hill",
"email": "xlorep@darkhelm.org",
"friendly_name": "Automated Daily Playlist Generator for Plex Music",
"github_user": "xlorepdarkhelm",
"license": "MIT",
"package_name": "playlist",
"project_name": "plex-playlist",
"version": "0.1.0"
}

View File

@@ -1,2 +0,0 @@
[darglint]
strictness = short

21
.flake8
View File

@@ -1,21 +0,0 @@
[flake8]
select = B,B9,C,D,DAR,E,F,N,RST,S,W
ignore = E203,E501,RST201,RST203,RST301,W503
max-line-length = 88
max-complexity = 10
docstring-convention = google
per-file-ignores = tests/*:S101
based-on-style = "pep8"
column-limit = 88
indent-width = 4
spaces_before_comment = 2
ALLOW_SPLIT_BEFORE_DICT_VALUE = false
DEDENT_CLOSING_BRACKETS = true
EACH_DICT_ENTRY_ON_SEPARATE_LINE = true
COALESCE_BRACKETS = true
USE_TABS = false
ALLOW_MULTILINE_LAMBDAS = true
BLANK_LINE_BEFORE_NESTED_CLASS_ON_DEF = true
INDENT_DICTIONARY_VALUE = true
SPLIT_BEFORE_EXPRESSION_AFTER_OPENING_PAREN = true
DISABLE_ENDING_COMMA_HEURISTIC = true

1
.gitattributes vendored
View File

@@ -1 +0,0 @@
* text=auto eol=lf

158
.gitignore vendored
View File

@@ -1,158 +0,0 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class
# C extensions
*.so
# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST
# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec
# Installer logs
pip-log.txt
pip-delete-this-directory.txt
# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/
# Translations
*.mo
*.pot
# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal
# Flask stuff:
instance/
.webassets-cache
# Scrapy stuff:
.scrapy
# Sphinx documentation
docs/_build/
# PyBuilder
.pybuilder/
target/
# Jupyter Notebook
.ipynb_checkpoints
# IPython
profile_default/
ipython_config.py
# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
.python-version
# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
__pypackages__/
# Celery stuff
celerybeat-schedule
celerybeat.pid
# SageMath parsed files
*.sage.py
# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/
# Spyder project settings
.spyderproject
.spyproject
# Rope project settings
.ropeproject
# mkdocs documentation
/site
# mypy
.mypy_cache/
.dmypy.json
dmypy.json
# Pyre type checker
.pyre/
# pytype static type analyzer
.pytype/
# Cython debug symbols
cython_debug/
# Swap
[._]*.s[a-v][a-z]
!*.svg # comment out if you don't need vector files
[._]*.sw[a-p]
[._]s[a-rt-v][a-z]
[._]ss[a-gi-z]
[._]sw[a-p]
# Session
Session.vim
Sessionx.vim
# Temporary
.netrwhist
*~
# Auto-generated tag files
tags
# Persistent undo
[._]*.un~

View File

@@ -1,57 +0,0 @@
---
repos:
- repo: local
hooks:
- id: black
name: black
entry: black
language: system
types: [python]
require_serial: true
- id: check-added-large-files
name: Check for added large files
entry: check-added-large-files
language: system
- id: check-toml
name: Check Toml
entry: check-toml
language: system
types: [toml]
- id: check-yaml
name: Check Yaml
entry: check-yaml
language: system
types: [yaml]
- id: end-of-file-fixer
name: Fix End of Files
entry: end-of-file-fixer
language: system
types: [text]
stages: [commit, push, manual]
- id: flake8
name: flake8
entry: flake8
language: system
types: [python]
require_serial: true
- id: reorder-python-imports
name: Reorder python imports
entry: reorder-python-imports
language: system
types: [python]
args:
[
--application-directories=src,
--py39-plus,
--exit-zero-even-if-changed,
]
- id: trailing-whitespace
name: Trim Trailing Whitespace
entry: trailing-whitespace-fixer
language: system
types: [text]
stages: [commit, push, manual]
- repo: https://github.com/prettier/pre-commit
rev: v2.1.2
hooks:
- id: prettier

View File

@@ -1,9 +0,0 @@
version: 2
sphinx:
configuration: docs/conf.py
formats: all
python:
version: 3.8
install:
- requirements: docs/requirements.txt
- path: .

View File

@@ -1,105 +0,0 @@
Contributor Covenant Code of Conduct
====================================
Our Pledge
----------
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
Our Standards
-------------
Examples of behavior that contributes to a positive environment for our community include:
- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall community
Examples of unacceptable behavior include:
- The use of sexualized language or imagery, and sexual attention or
advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email
address, without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting
Enforcement Responsibilities
----------------------------
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
Scope
-----
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
Enforcement
-----------
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at xlorep@darkhelm.org. All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
Enforcement Guidelines
----------------------
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
1. Correction
~~~~~~~~~~~~~
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
2. Warning
~~~~~~~~~~
**Community Impact**: A violation through a single incident or series of actions.
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
3. Temporary Ban
~~~~~~~~~~~~~~~~
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
4. Permanent Ban
~~~~~~~~~~~~~~~~
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within the community.
Attribution
-----------
This Code of Conduct is adapted from the `Contributor Covenant <homepage_>`__, version 2.0,
available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
Community Impact Guidelines were inspired by `Mozillas code of conduct enforcement ladder <https://github.com/mozilla/diversity>`__.
.. _homepage: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

View File

@@ -1,123 +0,0 @@
Contributor Guide
=================
Thank you for your interest in improving this project.
This project is open-source under the `MIT license`_ and
welcomes contributions in the form of bug reports, feature requests, and pull requests.
Here is a list of important resources for contributors:
- `Source Code`_
- `Documentation`_
- `Issue Tracker`_
- `Code of Conduct`_
.. _MIT license: https://opensource.org/licenses/MIT
.. _Source Code: https://github.com/xlorepdarkhelm/plex-playlist
.. _Documentation: https://plex-playlist.readthedocs.io/
.. _Issue Tracker: https://github.com/xlorepdarkhelm/plex-playlist/issues
How to report a bug
-------------------
Report bugs on the `Issue Tracker`_.
When filing an issue, make sure to answer these questions:
- Which operating system and Python version are you using?
- Which version of this project are you using?
- What did you do?
- What did you expect to see?
- What did you see instead?
The best way to get your bug fixed is to provide a test case,
and/or steps to reproduce the issue.
How to request a feature
------------------------
Request features on the `Issue Tracker`_.
How to set up your development environment
------------------------------------------
You need Python 3.6+ and the following tools:
- Poetry_
- Nox_
- nox-poetry_
Install the package with development requirements:
.. code:: console
$ poetry install
You can now run an interactive Python session,
or the command-line interface:
.. code:: console
$ poetry run python
$ poetry run plex-playlist
.. _Poetry: https://python-poetry.org/
.. _Nox: https://nox.thea.codes/
.. _nox-poetry: https://nox-poetry.readthedocs.io/
How to test the project
-----------------------
Run the full test suite:
.. code:: console
$ nox
List the available Nox sessions:
.. code:: console
$ nox --list-sessions
You can also run a specific Nox session.
For example, invoke the unit test suite like this:
.. code:: console
$ nox --session=tests
Unit tests are located in the ``tests`` directory,
and are written using the pytest_ testing framework.
.. _pytest: https://pytest.readthedocs.io/
How to submit changes
---------------------
Open a `pull request`_ to submit changes to this project.
Your pull request needs to meet the following guidelines for acceptance:
- The Nox test suite must pass without errors and warnings.
- Include unit tests. This project maintains 100% code coverage.
- If your changes add functionality, update the documentation accordingly.
Feel free to submit early, though—we can always iterate on this.
To run linting and code formatting checks before commiting your change, you can install pre-commit as a Git hook by running the following command:
.. code:: console
$ nox --session=pre-commit -- install
It is recommended to open an issue before starting work on anything.
This will allow a chance to talk it over with the owners and validate your approach.
.. _pull request: https://github.com/xlorepdarkhelm/plex-playlist/pulls
.. github-only
.. _Code of Conduct: CODE_OF_CONDUCT.rst

20
Jenkinsfile vendored
View File

@@ -1,20 +0,0 @@
pipeline {
agent {
docker {
image 'python:3.10-alpine3.14'
args '--rm --name playlist-testing'
}
}
stages {
stage('Test') {
steps {
sh 'echo ${USER}'
sh 'set'
sh 'pip3 install -U pip'
sh 'pip3 install wheel nox nox_poetry poetry'
sh 'nox --version'
sh 'poetry --version'
}
}
}
}

View File

@@ -1,22 +0,0 @@
MIT License
===========
Copyright © 2021 Cliff Hill
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
**The software is provided "as is", without warranty of any kind, express or
implied, including but not limited to the warranties of merchantability,
fitness for a particular purpose and noninfringement. In no event shall the
authors or copyright holders be liable for any claim, damages or other
liability, whether in an action of contract, tort or otherwise, arising from,
out of or in connection with the software or the use or other dealings in the
software.**

View File

@@ -1,99 +0,0 @@
Automated Daily Playlist Generator for Plex Music
=================================================
|PyPI| |Python Version| |License|
|Read the Docs| |Tests| |Codecov|
|pre-commit| |Black|
.. |PyPI| image:: https://img.shields.io/pypi/v/plex-playlist.svg
:target: https://pypi.org/project/plex-playlist/
:alt: PyPI
.. |Python Version| image:: https://img.shields.io/pypi/pyversions/plex-playlist
:target: https://pypi.org/project/plex-playlist
:alt: Python Version
.. |License| image:: https://img.shields.io/pypi/l/plex-playlist
:target: https://opensource.org/licenses/MIT
:alt: License
.. |Read the Docs| image:: https://img.shields.io/readthedocs/plex-playlist/latest.svg?label=Read%20the%20Docs
:target: https://plex-playlist.readthedocs.io/
:alt: Read the documentation at https://plex-playlist.readthedocs.io/
.. |Tests| image:: https://github.com/xlorepdarkhelm/plex-playlist/workflows/Tests/badge.svg
:target: https://github.com/xlorepdarkhelm/plex-playlist/actions?workflow=Tests
:alt: Tests
.. |Codecov| image:: https://codecov.io/gh/xlorepdarkhelm/plex-playlist/branch/main/graph/badge.svg
:target: https://codecov.io/gh/xlorepdarkhelm/plex-playlist
:alt: Codecov
.. |pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
:target: https://github.com/pre-commit/pre-commit
:alt: pre-commit
.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Black
Features
--------
* TODO
Requirements
------------
* TODO
Installation
------------
You can install *Automated Daily Playlist Generator for Plex Music* via pip_ from PyPI_:
.. code:: console
$ pip install plex-playlist
Usage
-----
Please see the `Command-line Reference <Usage_>`_ for details.
Contributing
------------
Contributions are very welcome.
To learn more, see the `Contributor Guide`_.
License
-------
Distributed under the terms of the `MIT license`_,
*Automated Daily Playlist Generator for Plex Music* is free and open source software.
Issues
------
If you encounter any problems,
please `file an issue`_ along with a detailed description.
Credits
-------
This project was generated from `@cjolowicz`_'s `Hypermodern Python Cookiecutter`_ template.
.. _@cjolowicz: https://github.com/cjolowicz
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _MIT license: https://opensource.org/licenses/MIT
.. _PyPI: https://pypi.org/
.. _Hypermodern Python Cookiecutter: https://github.com/cjolowicz/cookiecutter-hypermodern-python
.. _file an issue: https://github.com/xlorepdarkhelm/plex-playlist/issues
.. _pip: https://pip.pypa.io/
.. github-only
.. _Contributor Guide: CONTRIBUTING.rst
.. _Usage: https://plex-playlist.readthedocs.io/en/latest/usage.html

View File

@@ -1,10 +0,0 @@
---
comment: false
coverage:
status:
project:
default:
target: "100"
patch:
default:
target: "100"

View File

@@ -1 +0,0 @@
.. include:: ../CODE_OF_CONDUCT.rst

View File

@@ -1,15 +0,0 @@
"""Sphinx configuration."""
from datetime import datetime
project = "Automated Daily Playlist Generator for Plex Music"
author = "Cliff Hill"
copyright = f"{datetime.now().year}, {author}"
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.napoleon",
"sphinx_click",
"sphinx_rtd_theme",
]
autodoc_typehints = "description"
html_theme = "sphinx_rtd_theme"

View File

@@ -1,4 +0,0 @@
.. include:: ../CONTRIBUTING.rst
:end-before: github-only
.. _Code of Conduct: codeofconduct.html

View File

@@ -1,16 +0,0 @@
.. include:: ../README.rst
:end-before: github-only
.. _Contributor Guide: contributing.html
.. _Usage: usage.html
.. toctree::
:hidden:
:maxdepth: 1
usage
reference
contributing
Code of Conduct <codeofconduct>
License <license>
Changelog <https://github.com/xlorepdarkhelm/plex-playlist/releases>

View File

@@ -1 +0,0 @@
.. include:: ../LICENSE.rst

View File

@@ -1,13 +0,0 @@
Reference
=========
.. contents::
:local:
:backlinks: none
playlist.__main__
-----------------
.. automodule:: playlist.__main__
:members:

View File

@@ -1,3 +0,0 @@
sphinx==3.5.2
sphinx-click==2.6.0
sphinx-rtd-theme==0.5.1

View File

@@ -1,6 +0,0 @@
Usage
=====
.. click:: playlist.__main__:main
:prog: plex-playlist
:nested: full

View File

@@ -1,6 +0,0 @@
[settings]
line-length = 88
multi_line_output = 5
include_trailing_comma = true
known_future_library = "future"
indent = ' ' '

View File

@@ -1,20 +0,0 @@
[mypy]
check_untyped_defs = True
disallow_any_generics = True
disallow_incomplete_defs = True
disallow_subclassing_any = True
disallow_untyped_calls = True
disallow_untyped_decorators = True
disallow_untyped_defs = True
no_implicit_optional = True
no_implicit_reexport = True
pretty = True
show_column_numbers = True
show_error_codes = True
show_error_context = True
strict_equality = True
warn_redundant_casts = True
warn_return_any = True
warn_unreachable = True
warn_unused_configs = True
warn_unused_ignores = True

View File

@@ -1,193 +0,0 @@
"""Nox sessions."""
import shutil
import sys
from pathlib import Path
from textwrap import dedent
import nox
from nox_poetry import Session
from nox_poetry import session
package = "playlist"
python_versions = ["3.9"]
nox.options.sessions = (
"pre-commit",
"safety",
"mypy",
"tests",
"typeguard",
"xdoctest",
"docs-build",
)
def activate_virtualenv_in_precommit_hooks(session: Session) -> None: # noqa: CCR001
"""Activate virtualenv in hooks installed by pre-commit.
This function patches git hooks installed by pre-commit to activate the
session's virtual environment. This allows pre-commit to locate hooks in
that environment when invoked from git.
Args:
session: The Session object.
"""
if session.bin is None:
return # type: ignore [unreachable]
virtualenv = session.env.get("VIRTUAL_ENV")
if virtualenv is None:
return
hookdir = Path(".git") / "hooks"
if not hookdir.is_dir():
return
for hook in hookdir.iterdir():
if hook.name.endswith(".sample") or not hook.is_file():
continue
text = hook.read_text()
bindir = repr(session.bin)[1:-1] # strip quotes
if not (
Path("A") == Path("a") and bindir.lower() in text.lower() or bindir in text
):
continue
lines = text.splitlines()
if not (lines[0].startswith("#!") and "python" in lines[0].lower()):
continue
header = dedent(
f"""\
import os
os.environ["VIRTUAL_ENV"] = {virtualenv!r}
os.environ["PATH"] = os.pathsep.join((
{session.bin!r},
os.environ.get("PATH", ""),
))
""",
)
lines.insert(1, header)
hook.write_text("\n".join(lines))
@session(name="pre-commit", python="3.9")
def precommit(session: Session) -> None:
"""Lint using pre-commit."""
args = session.posargs or ["run", "--all-files", "--show-diff-on-failure"]
session.install(
"black",
"darglint",
"flake8",
"flake8-bandit",
"flake8-bugbear",
"flake8-docstrings",
"flake8-rst-docstrings",
"pep8-naming",
"pre-commit",
"pre-commit-hooks",
"reorder-python-imports",
)
session.run("pre-commit", *args)
if args and args[0] == "install":
activate_virtualenv_in_precommit_hooks(session)
@session(python="3.9")
def safety(session: Session) -> None:
"""Scan dependencies for insecure packages."""
requirements = session.poetry.export_requirements()
session.install("safety")
session.run("safety", "check", f"--file={requirements}", "--bare")
@session(python=python_versions)
def mypy(session: Session) -> None:
"""Type-check using mypy."""
args = session.posargs or ["src", "tests", "docs/conf.py"]
session.install(".")
session.install("mypy", "pytest", "pytest-asyncio", "pytest-mock", "types-all")
session.run("mypy", *args)
if not session.posargs:
session.run("mypy", f"--python-executable={sys.executable}", "noxfile.py")
@session(python=python_versions)
def tests(session: Session) -> None:
"""Run the test suite."""
session.install(".")
session.install(
"coverage[toml]",
"pytest",
"pytest-asyncio",
"pytest-mock",
"pygments",
)
try:
session.run("coverage", "run", "--parallel", "-m", "pytest", *session.posargs)
finally:
if session.interactive:
session.notify("coverage")
@session
def coverage(session: Session) -> None:
"""Produce the coverage report."""
# Do not use session.posargs unless this is the only session.
nsessions = len(session._runner.manifest)
has_args = session.posargs and nsessions == 1
args = session.posargs if has_args else ["report"]
session.install("coverage[toml]")
if not has_args and any(Path().glob(".coverage.*")):
session.run("coverage", "combine")
session.run("coverage", *args)
@session(python=python_versions)
def typeguard(session: Session) -> None:
"""Runtime type checking using Typeguard."""
session.install(".")
session.install("pytest", "pytest-asyncio", "pytest-mock", "typeguard", "pygments")
session.run("pytest", f"--typeguard-packages={package}", *session.posargs)
@session(python=python_versions)
def xdoctest(session: Session) -> None:
"""Run examples with xdoctest."""
args = session.posargs or ["all"]
session.install(".")
session.install("xdoctest[colors]")
session.run("python", "-m", "xdoctest", package, *args)
@session(name="docs-build", python="3.9")
def docs_build(session: Session) -> None:
"""Build the documentation."""
args = session.posargs or ["docs", "docs/_build"]
session.install(".")
session.install("sphinx", "sphinx-click", "sphinx-rtd-theme")
build_dir = Path("docs", "_build")
if build_dir.exists():
shutil.rmtree(build_dir)
session.run("sphinx-build", *args)
@session(python="3.9")
def docs(session: Session) -> None:
"""Build and serve the documentation with live reloading on file changes."""
args = session.posargs or ["--open-browser", "docs", "docs/_build"]
session.install(".")
session.install("sphinx", "sphinx-autobuild", "sphinx-click", "sphinx-rtd-theme")
build_dir = Path("docs", "_build")
if build_dir.exists():
shutil.rmtree(build_dir)
session.run("sphinx-autobuild", *args)

3512
poetry.lock generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,68 +0,0 @@
[tool.poetry]
name = "plex-playlist"
version = "0.1.0"
description = "Automated Daily Playlist Generator for Plex Music"
authors = ["Cliff Hill <xlorep@darkhelm.org>"]
license = "MIT"
readme = "README.rst"
homepage = "https://gitlab.com/xlorepdarkhelm/plex-playlist"
repository = "https://gitlab.com/xlorepdarkhelm/plex-playlist"
documentation = "https://plex-playlist.readthedocs.io"
packages = [
{ include = "playlist", from = "src" },
]
classifiers = [
"Programming Language :: Python :: 3.10",
]
[tool.poetry.urls]
Changelog = "https://gitlab.com/xlorepdarkhelm/plex-playlist/releases"
[tool.poetry.dependencies]
python = ">=3.10,<3.11"
click = "^8.0.3"
PlexAPI = "^4.5.2"
appdirs = "^1.4.4"
asyncpg = "^0.23.0"
uvloop = "^0.15.2"
desert = "^2020.11.18"
numpy = "^1.21.2"
typeguard = "^2.12.1"
gino = "^1.0.1"
quart = "^0.16.3"
marshmallow-sqlalchemy = "^0.27.0"
strictyaml = "^1.6.1"
[tool.poetry.dev-dependencies]
typeguard = "^2.12.0"
jupyter = "^1.0.0"
pre-commit = "^2.13.0"
pre-commit-hooks = "^4.0.1"
pytest = "^6.2.5"
pytest-asyncio = "^0.15.1"
pytest-mock = "^3.6.1"
black = "^22.1.0"
types-all = "^1.0.0"
[tool.poetry.scripts]
plex-playlist = "playlist.__main__:main"
[tool.black]
line-length = 88
target-version = ["py310"]
[tool.coverage.paths]
source = ["src", "*/site-packages"]
[tool.coverage.run]
branch = true
source = ["playlist"]
[tool.coverage.report]
show_missing = true
fail_under = 100
[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"

View File

@@ -1 +0,0 @@
"""Automated Daily Playlist Generator for Plex Music."""

View File

@@ -1,15 +0,0 @@
"""Command-line interface."""
import click
from playlist.plex import server
@click.command()
@click.version_option() # type: ignore
def main() -> None:
"""Automated Daily Playlist Generator for Plex Music."""
print(server)
if __name__ == "__main__":
main(prog_name="plex-playlist") # pragma: no cover

View File

@@ -1 +0,0 @@
"""Package containing all data classes used for the application."""

View File

@@ -1,35 +0,0 @@
"""Utility functions & classes used in the application."""
from __future__ import annotations
import functools
import typing
import desert
import marshmallow
DataSub = typing.TypeVar("DataSub", bound="BaseData")
class BaseData:
"""Base class for data classes in the application."""
@classmethod # type: ignore [misc]
@property
@functools.cache
def Schema(cls: type[BaseData]) -> marshmallow.Schema: # noqa: N802
"""The marshmallow Schema object for this data class."""
return desert.schema(cls)
@classmethod
def load(cls: type[BaseData], data: dict[str, object]) -> DataSub:
"""Load the given data dictionary into a class instance."""
return typing.cast(DataSub, cls.Schema.load(data)) # type: ignore [attr-defined]
def dump(self: BaseData) -> dict[str, object]:
"""Dump the class instance into a data dictionary."""
cls = type(self)
return typing.cast(
dict[str, object],
cls.Schema.dump(self), # type: ignore [attr-defined]
)

View File

@@ -1,53 +0,0 @@
"""Application-level constants."""
import concurrent.futures
import dataclasses
import datetime
import pathlib
import appdirs # type: ignore
@dataclasses.dataclass(frozen=True)
class _Defaults:
BATCH_SIZE: int
PROCESS_DELAY: int
DURATION: int
PLAYTIME: datetime.timedelta
MAX_TRACKS: int
@dataclasses.dataclass(frozen=True)
class _Paths:
CONFIG: pathlib.Path
DATA: pathlib.Path
CACHE: pathlib.Path
LOG: pathlib.Path
APPNAME = "plex-playlist"
APPAUTHOR = "Cliff Hill"
_dirs = appdirs.AppDirs(APPNAME, APPAUTHOR)
DEFAULTS = _Defaults(
BATCH_SIZE=1000,
PROCESS_DELAY=0,
DURATION=0,
PLAYTIME=datetime.timedelta(days=1),
MAX_TRACKS=0,
)
PROCESS_POOL = concurrent.futures.ProcessPoolExecutor()
MAX_PROCESSES = PROCESS_POOL._max_workers # type: ignore [attr-defined]
SETTINGS_FILENAME = "settings.yaml"
PATHS = _Paths(
CONFIG=pathlib.Path(_dirs.user_config_dir),
DATA=pathlib.Path(_dirs.user_data_dir),
CACHE=pathlib.Path(_dirs.user_cache_dir),
LOG=pathlib.Path(_dirs.user_log_dir),
)

View File

@@ -1,41 +0,0 @@
"""Contains the data models used throughout the application."""
import dataclasses
import datetime
import desert
import marshmallow
from playlist.data import base
from playlist.data.sql import db
@dataclasses.dataclass
class Track(db.Model, base.BaseData): # type: ignore [misc]
"""Model defining a Track object."""
___tablename__ = "tracks"
id: int = dataclasses.field(
init=False,
repr=False,
default=db.Column(db.Integer(), primary_key=True),
)
plex_id: int = db.Column(db.Integer)
track_num: int = db.Column(db.Integer)
title: str = db.Column(db.String)
artist: str = db.Column(db.String)
album_num: int = db.Column(db.Integer)
album: str = db.Column(db.String)
album_artist: str = db.Column(db.String)
duration: int = db.Column(db.Integer)
comments: str = db.Column(db.String)
added: datetime.datetime = db.Column(db.DateTime)
play_count: int = db.Column(db.Integer)
rating: int | None = dataclasses.field(
default=db.Column(db.Integer(), nullable=True, default=None),
metadata=desert.metadata(marshmallow.fields.Int(allow_none=True)),
)
played: datetime.datetime | None = dataclasses.field(
default=db.Column(db.Integer, nullable=True, default=None),
metadata=desert.metadata(marshmallow.fields.DateTime(allow_none=True)),
)

View File

@@ -1,187 +0,0 @@
"""Define and control the Settings object for the playlist app."""
from __future__ import annotations
import collections.abc
import contextlib
import dataclasses
import datetime
import functools
import getpass
import json
import pathlib
import typing
import plexapi.myplex
import strictyaml
from playlist.data import base
from playlist.data import const
__all__ = ["get", "modify"]
class YamlData(base.BaseData):
"""Base class for strictyaml classes."""
@classmethod # type: ignore [misc]
@property
@functools.cache
def strictyaml_schema(cls: type[YamlData]) -> strictyaml.Map:
"""Get the strictyaml schema for this class."""
field_map = {}
for field in dataclasses.fields(cls):
try:
field_map[field.name] = globals()[field.type].strictyaml_schema
except (KeyError, AttributeError):
match field.type:
case "int":
field_type = strictyaml.Int
case "str":
field_type = strictyaml.Str
case "float":
field_type = strictyaml.Float
case "datetime.timedelta":
field_type = strictyaml.Int
case "datetime.datetime":
field_type = strictyaml.Datetime
case _:
raise TypeError
field_map[field.name] = field_type()
return strictyaml.Map(field_map)
@dataclasses.dataclass
class CredentialSettings(YamlData):
"""Credentials component for Settings object."""
baseurl: str
token: str
@classmethod
def create(cls: type[CredentialSettings]) -> CredentialSettings: # pragma: no cover
"""Get the credentials to store in the Settings instance.
Returns:
CredentialSettings: The dictionary containing the baseurl and token string
to connect with.
"""
username = input("Plex Username: ")
password = getpass.getpass("Plex Password: ")
server = input("Plex Server: ")
account = plexapi.myplex.MyPlexAccount(username, password)
plex = account.resource(server).connect()
return CredentialSettings(baseurl=plex._baseurl, token=plex._token)
@dataclasses.dataclass
class DownloadSettings(YamlData):
"""DownloadSettingser options for Settings object."""
batch_size: int
process_delay: float
@classmethod
def create(cls: type[DownloadSettings]) -> DownloadSettings:
return cls(
batch_size=const.DEFAULTS.BATCH_SIZE,
process_delay=const.DEFAULTS.PROCESS_DELAY,
)
@dataclasses.dataclass
class TrackSettings(YamlData):
"""Track options for Settings object."""
duration: float
@classmethod
def create(cls: type[TrackSettings]) -> TrackSettings:
return cls(duration=const.DEFAULTS.DURATION)
@dataclasses.dataclass
class PlaylistSettings(YamlData):
"""Playlist options for Settings object."""
playtime: datetime.timedelta
max_tracks: int
@classmethod
def create(cls: type[PlaylistSettings]) -> PlaylistSettings:
return cls(
playtime=const.DEFAULTS.PLAYTIME,
max_tracks=const.DEFAULTS.MAX_TRACKS,
)
@dataclasses.dataclass
class Settings(YamlData):
"""Settings object, loaded from settings.yaml file."""
creds: CredentialSettings = dataclasses.field(
default_factory=CredentialSettings.create,
)
download: DownloadSettings = dataclasses.field(
default_factory=DownloadSettings.create,
)
track: TrackSettings = dataclasses.field(default_factory=TrackSettings.create)
playlist: PlaylistSettings = dataclasses.field(
default_factory=PlaylistSettings.create,
)
@classmethod
def yaml_read(
cls: type[Settings],
filepath: pathlib.Path,
) -> Settings:
"""Read the given YAML file and convert it into an object."""
try:
with filepath.open() as fp:
yaml_data = strictyaml.load(fp.read(), cls.strictyaml_schema)
return typing.cast(Settings, cls.load(yaml_data.data))
except strictyaml.YAMLValidationError:
return cls.yaml_create(filepath)
def yaml_write(self: Settings, filepath: pathlib.Path) -> None:
"""Write this object as the given YAML file."""
data: type(self).Dict = self.dump() # type: ignore [valid-type]
with filepath.open(mode="w") as fp:
yaml_data = strictyaml.as_document(data)
fp.write(yaml_data.as_yaml())
@classmethod
def yaml_create(
cls: type[Settings],
filepath: pathlib.Path,
) -> Settings: # pragma: no cover
"""Create the YAML file with this object."""
data = cls()
data.yaml_write(filepath)
return data
@functools.cache
def get() -> Settings: # pragma: no cover
"""Get the Settings object instance."""
filepath = const.PATHS.CONFIG / const.SETTINGS_FILENAME
instance: Settings
try:
instance = Settings.yaml_read(filepath)
except FileNotFoundError:
const.PATHS.CONFIG.mkdir(parents=True, exist_ok=True)
instance = Settings.yaml_create(filepath)
return instance
@contextlib.contextmanager
def modify() -> collections.abc.Generator[Settings, None, None]: # pragma: no cover
"""Provide the Settings object to make a modification and automatically save it."""
s = get()
try:
yield s
finally:
filepath = const.PATHS.CONFIG / const.SETTINGS_FILENAME
s.yaml_write(filepath)

View File

@@ -1,4 +0,0 @@
"""Contains the gino DB connection for the application."""
import gino
db = gino.Gino()

View File

@@ -1 +0,0 @@
"""Package containing the full plexapi wrapper/implementation."""

View File

@@ -1,207 +0,0 @@
"""Contains the code to communicate to the Plex server."""
import asyncio
import collections.abc
import statistics
import time
import typing
import plexapi.audio # type: ignore [import]
import plexapi.myplex # type: ignore [import]
import plexapi.server # type: ignore [import]
from playlist import utils
from playlist.data import const
from playlist.data import models
from playlist.data import settings
__all__ = ["gen_tracks", "total_track_count"]
throttle = asyncio.BoundedSemaphore(const.MAX_PROCESSES)
def calc_delay(times: list[float], weights: list[float]) -> None:
"""Calculate the process delay.
This is based on a weighted harmonic mean of the times the processes took in
the last run.
Args:
times: The list of times (as seconds) to use for the calculation.
weights: The list of weights from 0 to < 1.0 for the calculation.
"""
with settings.modify() as s:
avg_time_per_batch = utils.harmonic_mean(times, weights=weights)
delay = avg_time_per_batch / const.MAX_PROCESSES
s.download.process_delay = round(delay, ndigits=3)
def calc_duration(durations: list[int]) -> None:
"""Calculate the average duration and max tracks to play each day.
This is based on the geometric mean of the durations of every track loaded from
Plex. The maximum tracks to load for a day is based on the average duration calculated
and the amount of time that the system was played the previous day.
Args:
durations: The list of durations (in seconds) for the calculation.
"""
with settings.modify() as s:
avg_track_duration = statistics.geometric_mean(durations)
s.track.duration = round(avg_track_duration / 1000, ndigits=3)
playtime_seconds = s.playlist.playtime.total_seconds()
s.playlist.max_tracks = int(playtime_seconds / avg_track_duration)
async def gen_tracks(
*,
batch_size: int = settings.get().download.batch_size,
) -> collections.abc.AsyncGenerator[models.Track, None]:
"""Generate all Tracks from the Server, asynchronously.
Args:
batch_size: determines how many Tracks are pulled from the Server at a time.
Yields:
models.Track: The Track that was pulled from Plex.
"""
loop = asyncio.get_running_loop()
times = []
weights = []
durations = []
batches = [
asyncio.create_task(_downloader(ndx, size, loop))
async for ndx, size in _gen_batch_params(batch_size)
]
for batch_task in asyncio.as_completed(batches):
process_time, batch = await batch_task
weight = len(batch) / batch_size
times.append(process_time * weight)
weights.append(weight)
for track in batch:
durations.append(track.duration)
yield track
calc_delay(times, weights)
calc_duration(durations)
async def total_track_count() -> int:
"""Get the total number of tracks in the server.
Returns:
int: The total number of tracks in plex.
"""
server = plexapi.server.PlexServer(**settings.get().creds.dump())
loop = asyncio.get_running_loop()
num_tracks: int = await loop.run_in_executor(
None,
(
lambda: typing.cast(
int,
server.library.section("Music").totalViewSize("track"),
)
),
)
return num_tracks
async def _downloader(
pos: int,
size: int,
loop: asyncio.AbstractEventLoop,
) -> tuple[float, list[models.Track]]:
"""Download a batch of tracks from Plex, by running it inside a Process Pool.
Args:
pos: The index number of the batch to retrieve.
size: The size of the batch to retrieve.
loop: The asyncio event loop to use.
Returns:
tuple[float, list[models.Track]: The time (in seconds) to process, and
the batch of Tracks that were retrieved, in dictionary form.
"""
async with throttle:
start = time.time()
batch = await loop.run_in_executor(
const.PROCESS_POOL,
_get_track_batch,
size,
pos,
)
end = time.time()
process_time = end - start
return process_time, batch
def _get_track_batch(
size: int,
pos: int,
) -> list[models.Track]:
"""Get a batch of Tracks from the Plex Server.
Args:
size: The size of the batch to retrieve.
pos: The index number of the batch to retrieve.
Returns:
list[models.Track]: The process time and list of Tracks retrieved,
in dictionary form.
"""
server = plexapi.server.PlexServer(**settings.get().creds.dump())
batch = server.library.section("Music").searchTracks(
maxresults=size,
container_start=pos,
container_size=size,
)
return [_track_dump(track) for track in batch]
def _track_dump(track: plexapi.audio.Track) -> models.Track:
"""Convert a PlexAPI Audio Track object into a Track in dictionary form.
Args:
track: The PlexAPI Audio Track to convert from.
Returns:
models.Track: The dictionary form for the Track object converted to.
"""
return models.Track(
plex_id=track.ratingKey,
track_num=track.index,
title=track.title,
artist=track.artist().title,
album_num=track.parentIndex,
album=track.parentTitle,
album_artist=track.grandparentTitle,
duration=track.duration,
rating=track.userRating,
comments=track.summary,
added=track.addedAt,
play_count=track.viewCount,
played=track.lastViewedAt,
)
async def _gen_batch_params(
batch_size: int,
) -> collections.abc.AsyncGenerator[tuple[int, int], None]:
"""Generate parameters for batches to be processed with.
This slows down processing of the first few batches to allow for different process
pool workers to be staggered, and make the processing more smooth.
Args:
batch_size: determines how many Tracks are pulled from the Plex Server at a time.
Yields:
tuple[int, int]: The batch index and batch size to process.
"""
quotient, remainder = divmod(await total_track_count(), batch_size)
for ndx in range(quotient):
if ndx and ndx < const.MAX_PROCESSES:
await asyncio.sleep(settings.get().download.process_delay)
yield ndx, batch_size
if quotient and quotient < const.MAX_PROCESSES: # pragma: no cover
await asyncio.sleep(settings.get().download.process_delay)
yield quotient, remainder

View File

View File

@@ -1,40 +0,0 @@
"""Utility functions & classes used in the application."""
from __future__ import annotations
import collections.abc
import contextlib
import datetime
@contextlib.contextmanager
def time_this() -> collections.abc.Generator[None, None, None]: # pragma: no cover
"""Context manager to time the execution of a block of code."""
start = datetime.datetime.now()
try:
yield
finally:
end = datetime.datetime.now()
print(f"Elapsed time: {end - start}")
def harmonic_mean(
data: collections.abc.Sequence[float],
*,
weights: collections.abc.Sequence[float] | None = None,
) -> float:
"""Calculate the [weighted] harmonic mean of the given data.
Args:
data: The sequence of values to calculate.
weights: The sequence of weights to apply to the calculation. If not
given it assumes all weights are 1.
Returns:
float: The [weighted] harmonic mean of the data.
"""
if weights is None: # pragma: no cover
weights = [1] * len(data)
numerator = sum(weights)
denominator = sum(weight / value for weight, value in zip(weights, data))
return numerator / denominator

View File

@@ -1 +0,0 @@
"""Test suite for the playlist package."""

View File

@@ -1 +0,0 @@
"""Tests for the playlist.data package."""

View File

@@ -1,55 +0,0 @@
"""Tests for the playlist.data.base module."""
import dataclasses
import datetime
import typing
import pytest
from playlist.data import base
@dataclasses.dataclass
class Dummy(base.BaseData):
"""Dummy class for tests."""
name: str
some_id: int
calc: float
flag: bool
modified: datetime.datetime
@pytest.fixture
def dummyobj() -> Dummy:
"""Make a dummy object for testing."""
return Dummy(
name="Something",
some_id=1,
calc=0.1,
flag=True,
modified=datetime.datetime.now(),
)
@pytest.fixture
def dummydict(dummyobj: Dummy) -> dict[str, object]:
"""Make a dummy dictionary for testing."""
return {
"name": dummyobj.name,
"some_id": dummyobj.some_id,
"calc": dummyobj.calc,
"flag": dummyobj.flag,
"modified": "T".join(str(dummyobj.modified).split(" ")),
}
def test_load(dummydict: dict[str, object], dummyobj: Dummy) -> None:
"""Validate that <data class>.load() works."""
result: Dummy = Dummy.load(dummydict)
assert result == dummyobj
def test_dump(dummydict: dict[str, typing.Any], dummyobj: Dummy) -> None:
"""Validate that <data class instance>.dump() works."""
result = dummyobj.dump()
assert result == dummydict

View File

@@ -1,35 +0,0 @@
"""Tests for validating the Settings object."""
import base64
import os
import pathlib
import pytest
from playlist.data import settings
@pytest.fixture
def example_settings() -> settings.Settings:
"""Make testable Settings object."""
return settings.Settings(
creds=settings.CredentialSettings(
baseurl="http://nowhere.huh",
token=base64.b64encode(os.urandom(8)).decode("utf-8"),
),
)
@pytest.fixture
def settings_filepath(tmp_path: pathlib.Path) -> pathlib.Path:
"""Get the path to use for the settings file."""
return tmp_path / "fake_settings.yaml"
def test_yaml(
example_settings: settings.Settings,
settings_filepath: pathlib.Path,
) -> None:
"""Test the YAML read/write operations."""
example_settings.yaml_write(settings_filepath)
result = example_settings.yaml_read(settings_filepath)
assert result == example_settings

View File

@@ -1 +0,0 @@
"""Tests for the playlist.plex package."""

View File

@@ -1,204 +0,0 @@
"""Tests for the playlist.plex.server module."""
import asyncio
import datetime
import unittest.mock
import pytest
from playlist.data import models
from playlist.data import settings
from playlist.plex import server
def test_calc_delay(mocker): # type: ignore [no-untyped-def]
"""Test the calc_delay function."""
mock_settings = mocker.patch("playlist.plex.server.settings")
mock_const = mocker.patch("playlist.plex.server.const")
mock_s = mock_settings.modify.return_value.__enter__.return_value
mock_const.MAX_PROCESSES = 1
times: list[float] = [100, 100, 100]
weights: list[float] = [1, 1, 1]
server.calc_delay(times, weights)
result = mock_s.download.process_delay
assert result == 100
def test_calc_duration(mocker): # type: ignore [no-untyped-def]
"""Test the calc_duration function."""
mock_settings = mocker.patch("playlist.plex.server.settings")
durations = [100, 100, 100]
mock_s = mock_settings.modify.return_value.__enter__.return_value
mock_s.playlist.playtime.total_seconds.return_value = 300
server.calc_duration(durations)
result = mock_s.playlist.max_tracks
assert result == 2
@pytest.mark.asyncio
async def test_gen_tracks(mocker, fake_track): # type: ignore [no-untyped-def]
"""Test the gen_tracks asynchronous generator."""
mock_downloader = mocker.patch(
"playlist.plex.server._downloader",
new_callable=unittest.mock.AsyncMock,
)
mock_gen_batch_params = mocker.patch("playlist.plex.server._gen_batch_params")
mock_models = mocker.patch("playlist.plex.server.models")
mock_calc_delay = mocker.patch("playlist.plex.server.calc_delay")
mock_calc_duration = mocker.patch("playlist.plex.server.calc_duration")
mock_downloader.return_value = (1, [fake_track])
async def fake_gen_batch_params(*args): # type: ignore
for item in [(0, 1), (1, 1)]:
yield item
mock_gen_batch_params.side_effect = fake_gen_batch_params
mock_models.Track.load.return_value.duration = 1
results = [item async for item in server.gen_tracks(batch_size=1)]
assert len(results) == 2
assert mock_calc_delay.called
assert mock_calc_duration.called
@pytest.mark.asyncio
async def test_total_track_count(mocker): # type: ignore [no-untyped-def]
"""Test the total_track_count coroutine."""
mock_plexapi_server = mocker.patch("playlist.plex.server.plexapi.server")
mock_server = mock_plexapi_server.PlexServer.return_value
mock_total_view_size = mock_server.library.section.return_value.totalViewSize
mock_total_view_size.return_value = 1
result = await server.total_track_count()
assert result == 1
def test_get_creds(mocker): # type: ignore [no-untyped-def]
"""Test the get_creds function."""
mock_plexapi_myplex = mocker.patch("playlist.plex.server.plexapi.myplex")
mock_input = mocker.patch("builtins.input")
mock_getpass = mocker.patch("playlist.plex.server.getpass")
mock_account = mock_plexapi_myplex.MyPlexAccount.return_value
mock_plex = mock_account.resource.return_value.connect.return_value
mock_plex._baseurl = "Not a valid URL"
mock_plex._token = "Fake token"
expected = settings.CredentialSettings(
baseurl=mock_plex._baseurl,
token=mock_plex._token,
)
result = server.get_creds()
assert result == expected
assert mock_input.called
assert mock_getpass.getpass.called
@pytest.mark.asyncio
async def test_downloader(mocker): # type: ignore [no-untyped-def]
"""Test the _downloader coroutine."""
async def fake_run_in_executor(*args): # type: ignore
await asyncio.sleep(0.1)
return "Fake batch"
mock_loop = unittest.mock.MagicMock()
mock_loop.run_in_executor.side_effect = fake_run_in_executor
result = await server._downloader(1, 1, mock_loop)
process_time, batch = result
assert batch
assert process_time >= 0.1
@pytest.fixture
def fake_track(fake_plextrack): # type: ignore [no-untyped-def]
"""Make a fake track dict object."""
return models.Track(
plex_id=fake_plextrack.ratingKey,
track_num=fake_plextrack.index,
title=fake_plextrack.title,
artist=fake_plextrack.artist().title,
album_num=fake_plextrack.parentIndex,
album=fake_plextrack.parentTitle,
album_artist=fake_plextrack.grandparentTitle,
duration=fake_plextrack.duration,
rating=fake_plextrack.userRating,
comments=fake_plextrack.summary,
added=fake_plextrack.addedAt,
play_count=fake_plextrack.viewCount,
played=fake_plextrack.lastViewedAt,
)
def test_get_track_batch(mocker, fake_track): # type: ignore [no-untyped-def]
"""Test _get_track_batch function."""
mock_plexapi_server = mocker.patch("playlist.plex.server.plexapi.server")
mock_server = mock_plexapi_server.PlexServer.return_value
mock_search_tracks = mock_server.library.section.return_value.searchTracks
mock_search_tracks.return_value = ["Not a track."]
mock_track_dump = mocker.patch("playlist.plex.server._track_dump")
mock_track_dump.return_value = fake_track
result = server._get_track_batch(1, 1)
assert len(result)
assert mock_track_dump.called
@pytest.fixture
def fake_plextrack(): # type: ignore [no-untyped-def]
"""Mock up a fake Plex track for testing."""
mock_track = unittest.mock.MagicMock()
mock_track.configure_mock(
ratingKey=1,
index=1,
title="Nothing",
parentIndex=1,
parentTile="Nothing",
grandparentTitle="Nothing",
duration=1000,
userRating=1,
summary="Whatever",
addedAt=datetime.datetime.now(),
viewCount=1,
lastViewedAt=None,
)
mock_track.artist.return_value.title = "Nothing"
return mock_track
def test_track_dump(fake_plextrack, fake_track): # type: ignore [no-untyped-def]
"""Test the _track_dump function."""
result = server._track_dump(fake_plextrack)
assert result == fake_track
@pytest.mark.asyncio
async def test_gen_batch_params(mocker): # type: ignore [no-untyped-def]
"""Test the _gen_batch_params asynchronous generator."""
mock_total_track_count = mocker.patch(
"playlist.plex.server.total_track_count",
new_callable=unittest.mock.AsyncMock,
)
mock_total_track_count.return_value = 12
mock_const = mocker.patch("playlist.plex.server.const")
mock_const.MAX_PROCESSES = 10
mocker.patch("playlist.plex.server.settings")
mocker.patch(
"playlist.plex.server.asyncio",
new_callable=unittest.mock.AsyncMock,
)
result = [item async for item in server._gen_batch_params(5)]
assert len(result) == 3

View File

@@ -1,17 +0,0 @@
"""Test cases for the __main__ module."""
import pytest
from click.testing import CliRunner
from playlist import __main__
@pytest.fixture
def runner() -> CliRunner:
"""Fixture for invoking command-line interfaces."""
return CliRunner()
def test_main_succeeds(runner: CliRunner) -> None:
"""It exits with a status code of zero."""
result = runner.invoke(__main__.main)
assert result.exit_code == 0