Address deprecations, update coding conventions, use git-based versioning #19

Zeitsperre · 2024-05-15T15:47:11Z

Changes

Updates the code base to use Python3.8+ coding conventions
Added some more specific exception handling
Added a very simple pre-commit configuration with coding convention checking and linting
Removed the poetry.lock file
Configured the GitHub Workflow to test against more Python versions
Added .idea to .gitignore (for JetBrains IDEs)
Publishing no longer uses twine, opting for native poetry commands
Versioning uses git tags with the poetry-version-plugin
Addressed DeprecationWarning message being emitted in newer versions of Python
Cleaned up a few imports

Additional context

These are deprecation notices that were being raised in downstream projects:

Python3.11+:

../../../micromamba/envs/raven/lib/python3.12/site-packages/metalink/GPG.py:80
../../../micromamba/envs/raven/lib/python3.12/site-packages/metalink/GPG.py:80
../../../micromamba/envs/raven/lib/python3.12/site-packages/metalink/GPG.py:80
../../../micromamba/envs/raven/lib/python3.12/site-packages/metalink/GPG.py:80
  /home/runner/micromamba/envs/raven/lib/python3.12/site-packages/metalink/GPG.py:80: DeprecationWarning: 'locale.getdefaultlocale' is deprecated and slated for removal in Python 3.15. Use setlocale(), getencoding() and getlocale() instead.
    localelang = locale.getdefaultlocale()[0]

../../../micromamba/envs/raven/lib/python3.12/site-packages/metalink/proxy.py:110
../../../micromamba/envs/raven/lib/python3.12/site-packages/metalink/proxy.py:110
../../../micromamba/envs/raven/lib/python3.12/site-packages/metalink/proxy.py:110
../../../micromamba/envs/raven/lib/python3.12/site-packages/metalink/proxy.py:110
  /home/runner/micromamba/envs/raven/lib/python3.12/site-packages/metalink/proxy.py:110: DeprecationWarning: 'locale.getdefaultlocale' is deprecated and slated for removal in Python 3.15. Use setlocale(), getencoding() and getlocale() instead.
    localelang = locale.getdefaultlocale()[0]

../../../micromamba/envs/raven/lib/python3.12/site-packages/metalink/download.py:157
../../../micromamba/envs/raven/lib/python3.12/site-packages/metalink/download.py:157
../../../micromamba/envs/raven/lib/python3.12/site-packages/metalink/download.py:157
../../../micromamba/envs/raven/lib/python3.12/site-packages/metalink/download.py:157
  /home/runner/micromamba/envs/raven/lib/python3.12/site-packages/metalink/download.py:157: DeprecationWarning: 'locale.getdefaultlocale' is deprecated and slated for removal in Python 3.15. Use setlocale(), getencoding() and getlocale() instead.
    lang = locale.getdefaultlocale()[0]

../../../micromamba/envs/raven/lib/python3.12/site-packages/metalink/download.py:204
../../../micromamba/envs/raven/lib/python3.12/site-packages/metalink/download.py:204
../../../micromamba/envs/raven/lib/python3.12/site-packages/metalink/download.py:204
../../../micromamba/envs/raven/lib/python3.12/site-packages/metalink/download.py:204
  /home/runner/micromamba/envs/raven/lib/python3.12/site-packages/metalink/download.py:204: DeprecationWarning: 'locale.getdefaultlocale' is deprecated and slated for removal in Python 3.15. Use setlocale(), getencoding() and getlocale() instead.
    localelang = locale.getdefaultlocale()[0]

Specific to Python3.10 and Python3.11:

 ../../../micromamba/envs/raven/lib/python3.11/site-packages/metalink/download.py:132
../../../micromamba/envs/raven/lib/python3.11/site-packages/metalink/download.py:132
../../../micromamba/envs/raven/lib/python3.11/site-packages/metalink/download.py:132
../../../micromamba/envs/raven/lib/python3.11/site-packages/metalink/download.py:132
  /home/runner/micromamba/envs/raven/lib/python3.11/site-packages/metalink/download.py:132: DeprecationWarning: ssl.PROTOCOL_TLS is deprecated
    SSL_ANYTHING = ssl.SSLContext(ssl.PROTOCOL_SSLv23)

../../../micromamba/envs/raven/lib/python3.11/site-packages/metalink/download.py:134
../../../micromamba/envs/raven/lib/python3.11/site-packages/metalink/download.py:134
../../../micromamba/envs/raven/lib/python3.11/site-packages/metalink/download.py:134
../../../micromamba/envs/raven/lib/python3.11/site-packages/metalink/download.py:134
  /home/runner/micromamba/envs/raven/lib/python3.11/site-packages/metalink/download.py:134: DeprecationWarning: ssl.PROTOCOL_TLSv1_2 is deprecated
    SSL_HIGH = ssl.SSLContext(ssl.PROTOCOL_TLSv1_2)

These have been addressed

…pre None using boolean comparison

bneijt · 2024-06-04T05:17:58Z

.github/workflows/main.yml

@@ -1,19 +1,32 @@
-name: main
+name: pymetalink Testing Suite


Rename breaks pull request validation rules, please revert

bneijt · 2024-06-04T05:18:21Z

.github/workflows/publish.yml

        env:
-          TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
-          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+          POETRY_HTTP_BASIC_FOO_USERNAME: ${{ secrets.PYPI_USERNAME }}


bneijt · 2024-06-04T05:20:46Z

LICENSE.txt

@@ -1,21 +1,21 @@
 The MIT License (MIT)

-Copyright (c) 2016 Neil McNab, Hampus Wessman
+Copyright (c) 2007-2024 Neil McNab, Hampus Wessman, and other contributors


We need a set of designated copyright holders to make usage decisions, if we open this up we make it impossible to make decisions on licensing without reviewing with all previous contributers

Ah, understood. Would it make sense to add those who have contributed to date, or do we want to leave it to Neil and Bram?

I've also seen people listed for different years, so we could technically add yourself from when you adopted the project?

Adding people makes sense, we cna just have a contributors list and mention those poeple in the copyright statement, that would be fine. Legally it's probably very hard to work with "go look at git to see who contributed to figure out who to contact for copyright issues" 😉

bneijt · 2024-06-04T05:21:55Z

debian/rules


 install: build
 	dh_testdir
 	dh_testroot
-	dh_clean -k 
+	dh_clean -k


We should split formatting changes into a new pr then rebase, all these tiny changes make it hard to review

I can see about splitting the formatting changes off. Shouldn't be too difficult.

bneijt · 2024-06-04T05:23:31Z

pyproject.toml

+requires = ["poetry-core>=1.2.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.black]


I have been using ruff format a lot lately, it’s a lot fasten so I would prefer that, but a formatter is a good idea and we should push that in a separate pr

I've been using ruff in a few places as well. I'll verify what the configuration requires so that we solely use that tool instead of black.

bneijt · 2024-06-04T05:27:41Z

Dear contributor, sorry for the late reply and thank you for taking the time to open up a PR!

some changes I agree with, some I would love to split off into a separate pr. I don’t have a laptop this week, but will try to do a proper review next week. Could you consider moving the formatting to a new pr?

Zeitsperre · 2024-06-11T16:56:55Z

Closed in favour of #20 and #21

Zeitsperre added 6 commits May 15, 2024 11:30

update code styling for Python3.8+

ce0acbc

update testing configuration

c3a775b

update pins, remove poetry.lock

ce12b8e

add .pre-commit-config.yaml

7cba241

ignore .idea

7056dfd

typo fixes

864851c

Zeitsperre changed the title ~~Address deprecations, update~~ Address deprecations, update coding conventions May 15, 2024

Zeitsperre added 4 commits May 15, 2024 12:12

Update LICENSE texts and add entry to changelog

a686010

update changelog and package version

00eaba3

use poetry-version-plugin for setting version based on tag

77cd2ed

use poetry publish in lieu of twine

9d3b154

Zeitsperre changed the title ~~Address deprecations, update coding conventions~~ Address deprecations, update coding conventions, use git-based versioning May 15, 2024

Zeitsperre added 5 commits May 15, 2024 13:30

add configuration for black, add some basic linters to pre-commit

e6c1dcd

run pre-commit automated fixes for whitespace

fcabf56

run pre-commit automated fixes for black

59c9f3a

address DeprecationWarnings from locale.getdefaultlocale, do not coma…

ffe2016

…pre None using boolean comparison

address SSL deprecations, clean up imports

b9f5393

bneijt reviewed Jun 4, 2024

View reviewed changes

Zeitsperre mentioned this pull request Jun 11, 2024

Address Deprecations and obsolete usages, use git-based versioning #20

Merged

Zeitsperre closed this Jun 11, 2024

Zeitsperre mentioned this pull request Jun 17, 2024

Add Ruff formatter and pre-commit configurations #21

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Address deprecations, update coding conventions, use git-based versioning #19

Address deprecations, update coding conventions, use git-based versioning #19

Zeitsperre commented May 15, 2024 •

edited

Loading

bneijt Jun 4, 2024

bneijt Jun 4, 2024

bneijt Jun 4, 2024

Zeitsperre Jun 11, 2024

bneijt Jun 15, 2024

bneijt Jun 4, 2024

Zeitsperre Jun 11, 2024

bneijt Jun 4, 2024

Zeitsperre Jun 11, 2024

bneijt commented Jun 4, 2024

Zeitsperre commented Jun 11, 2024

Address deprecations, update coding conventions, use git-based versioning #19

Address deprecations, update coding conventions, use git-based versioning #19

Conversation

Zeitsperre commented May 15, 2024 • edited Loading

Changes

Additional context

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bneijt commented Jun 4, 2024

Zeitsperre commented Jun 11, 2024

Zeitsperre commented May 15, 2024 •

edited

Loading