Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Housekeeping #277

Merged
merged 4 commits into from
Dec 11, 2024
Merged

Housekeeping #277

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
45bb4d3
Use codecov-action v4 by default, v3 for 2.7
avylove Jul 4, 2024
a79641c
pylint tweaks
avylove Nov 23, 2024
c8c7900
Update Python versions
avylove Nov 23, 2024
57f6d5f
Fix Sphinx warnings
avylove Nov 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 21 additions & 8 deletions .github/workflows/tests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,25 +20,25 @@ jobs:
strategy:
fail-fast: false
matrix:
python-version: ['3.7', '3.8', '3.9', '3.10', '3.11', '3.12']
python-version: ['3.7', '3.8', '3.9', '3.10', '3.11', '3.12', '3.13']
test_quick: [1]

include:
- python-version: '3.12'
- python-version: '3.13'
label: Linting
toxenv: docformatter_check,flake8,flake8_tests,isort_check,mypy,sphinx,pydocstyle,pylint,pylint_tests

- python-version: '3.13-dev'
- python-version: '3.14-dev'
optional: true
toxenv: py313
toxpython: 3.13
toxenv: py314
toxpython: 3.14

- python-version: '3.12'
- python-version: '3.13'
test_keyboard: 1
test_raw: 1
test_quick: 0

- python-version: '3.12'
- python-version: '3.13'
os: windows-latest
test_quick: 0

Expand Down Expand Up @@ -93,7 +93,20 @@ jobs:
run: tox

- name: Upload to Codecov
if: ${{ matrix.label != 'linting' }}
if: ${{ matrix.label != 'linting' && matrix.python-version != '2.7' }}

uses: codecov/codecov-action@v4
with:
verbose: true
name: ${{ matrix.label || matrix.python-version }} ${{ startsWith(matrix.os, 'windows') && '(Windows)' || '' }}
token: ${{ secrets.CODECOV_TOKEN }}
fail_ci_if_error: true
os: ${{ startsWith(matrix.os, 'windows') && 'windows' || 'linux' }}
env_vars: TOXENV,TEST_QUICK,TEST_KEYBOARD,TEST_RAW

# Work around for https://github.com/codecov/codecov-action/issues/1277
- name: Upload to Codecov (2.7 workaround)
if: ${{ matrix.python-version == '2.7' && matrix.label != 'linting' }}

uses: codecov/codecov-action@v3
with:
Expand Down
2 changes: 1 addition & 1 deletion bin/generate-keycodes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ def main():
csv_header = """
.. csv-table:: All Terminal class attribute Keyboard codes, by name
:delim: |
:header: "Name", "Value", "Example Sequence(s)"
:header: "Name"| "Value"| "Example Sequence(s)"

"""
fname = os.path.abspath(
Expand Down
2 changes: 1 addition & 1 deletion blessed/sequences.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ def horizontal_distance(self, text):

return 0

# pylint: disable=too-many-arguments
# pylint: disable=too-many-positional-arguments
@classmethod
def build(cls, name, capability, attribute, nparams=0,
numeric=99, match_grouped=False, match_any=False,
Expand Down
2 changes: 1 addition & 1 deletion blessed/sequences.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ if TYPE_CHECKING:
_T = TypeVar("_T")

# pylint: disable=unused-argument,missing-function-docstring,missing-class-docstring
# pylint: disable=super-init-not-called
# pylint: disable=super-init-not-called,too-many-positional-arguments

class Termcap:
name: str = ...
Expand Down
3 changes: 1 addition & 2 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
import functools

# 3rd party
import sphinx_rtd_theme
import sphinx.environment
from docutils.utils import get_source_line

Expand Down Expand Up @@ -155,7 +154,7 @@ def wrapper(decorator):
# html_theme_options = {}

# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# html_theme_path = []
Copy link
Owner

@jquast jquast Dec 10, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You don't mention why to remove this, I think I put it here to match local development to the theme where it is published, in any case it uses a requirement "sphinx_rtd_theme" in docs/requirements.txt, so then that requirement should also be removed.

Sorry to be late, I've been busy with school work but that's all over tomorrow

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's because of this warning from Sphinx. We are treating warnings as errors.

WARNING: Calling get_html_theme_path is deprecated. If you are calling it to define html_theme_path, you are safe to remove that code.

But I think we can leave the dependency because we still have
html_theme = "sphinx_rtd_theme"

I think back in the day the theme loading needed extra help that isn't required anymore. But building locally, with the changes, the docs look the same as on Read the Docs.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, great! Thanks for figuring that out!


# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
Expand Down
2 changes: 2 additions & 0 deletions setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,8 @@ def _get_long_description(fname):
'Programming Language :: Python :: 3.9',
'Programming Language :: Python :: 3.10',
'Programming Language :: Python :: 3.11',
'Programming Language :: Python :: 3.12',
'Programming Language :: Python :: 3.13',
'Topic :: Software Development :: Libraries',
'Topic :: Software Development :: User Interfaces',
'Topic :: Terminals',
Expand Down
6 changes: 3 additions & 3 deletions tox.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ envlist =
pydocstyle
mypy
sphinx
py{27,35,36,37,38,39,310,311,312}
py{27,35,36,37,38,39,310,311,312,313}


####### Python Test Environments #######

[testenv]
basepython = python3.12
basepython = python3.13
passenv =
TEST_QUICK
TEST_KEYBOARD
Expand All @@ -37,7 +37,7 @@ deps =
commands =
pytest {posargs: --strict-markers --verbose --durations=3} tests

[testenv:py312]
[testenv:py313]
setenv =
TEST_QUICK = {env:TEST_QUICK:0}
TEST_KEYBOARD = {env:TEST_KEYBOARD:1}
Expand Down
Loading