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.

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

Draft 1.0 release notes #3069

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Draft 1.0 release notes #3069

wants to merge 2 commits into from

Conversation

tomchristie
Copy link
Member

@tomchristie tomchristie commented Jan 22, 2024

I'm drafting up here what our 1.0 release notes could look like, so that we've a single point of reference for deciding what does and does not make the cut.

Let's take a look...

Simplified transport configuration

As described at #947 (comment)

Includes PRs...

Stricter parameters

We don't necessarily need these changes, and I've not discussed them elsewhere. However they do align with a stricter more explicit approach. Zen of Python etc. I'd be perfectly happy dropping these, but might be worthwhile. Can discuss the motivation more in due course.

Minor cleanups

  • I have some planned documentation on the URL API that ties in with the "All components...".
  • Response.elapsed is a tidy one to remove, and can replaced with an example of how to handle it using event hooks. Discussion at Dropping `.elapsed` in favor of event hooks. #3012

Environment variables

The changes in "simplified transport configuration" end up removing all auto-environment-variable based configuration by default. There's easy migrations for re-enabling the existing functionalities.

Dependencies

@tomchristie tomchristie added the 1.0 proposal Pull requests proposing 1.0 API changes label Jan 22, 2024
Copy link
Contributor

@T-256 T-256 left a comment

Choose a reason for hiding this comment

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

LGTM 🎉
Is Removed section missed?

From #3022 (comment):

Also, we have other deprecated drops those pending to remove in v1.0.0 (IIUC):

  • proxies=
  • data= (non-Mapping objects)
  • cookies= (per-request)

@T-256 T-256 mentioned this pull request Jan 25, 2024
3 tasks
@tomchristie
Copy link
Member Author

@encode/maintainers How do we feel about this?
My inclination is that we should probably just push on with deprecations, and commit ourselves to a 1.0 release.

It's a more coherent, slightly stricter take on the API which all fits together really neatly.
Seems worth it.

sscherfke added a commit to sscherfke/nicegui that referenced this pull request Feb 3, 2024
- The "^" specifier is often too restrictive for 0.* versions so I would
  not recommend to use it in these cases:
  https://python-poetry.org/docs/dependency-specification/
- Markdown2: The issue from 2.4.11 was fixed in 2.4.12:
  - zauberzeug#2154
  - trentm/python-markdown2#546
  - https://github.com/trentm/python-markdown2/blob/master/CHANGES.md#python-markdown2-2412
- Watchfiles: Doesn't look like v1 will introduce breaking changes:
  samuelcolvin/watchfiles#186
- python-multipart: "^0.06" is "==0.0.6" which is too strict and
  at this stage, any release can potentially add breaking changes
- aiofiles: Uses CalVer and 24.0.0 is as likely to introduce breaking
  changes as 23.2.0.
- httpx: It does not look like 1.0.0 will introduce breaking changes
  (if you already fixed any deprecation warnings).  Testing against the
  1.0.0beata0 is advisable, though.
  encode/httpx#3069
- ifaddr: Development is rather slow, package looks quite stable.
  I don't think that a 0.3.0 will add breaking changes and a 1.0 is not
  in sight.
- pytest-asyncio: Restriction to >=0.19,<0.20 seems unwanted and updates
  are needed for recent pytest versions
- pytest: Has there been a reason to not support pytest7?  pytest8
  currently breaks some plugins, but this should be fixed soon.

Fixes: zauberzeug#2485
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1.0 proposal Pull requests proposing 1.0 API changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants