Allow int Subclasses in Query by Exahilosys · Pull Request #492 · aio-libs/yarl

Exahilosys · 2020-08-08T13:55:19Z

I have found myself having to do explicit type conversions of int subclasses that should definitely work.

What do these changes do?

This new check allows all int subclasses through except bool, which should obviously be rejected.

Are there changes in behavior for the user?

Nope. I can't imagine backward compatibility being an issue.

Checklist

I think the code is well written
Unit tests for the changes exist
Documentation reflects the changes
Add a new news fragment into the CHANGES folder
- name it <issue_id>.<type> (e.g. 588.bugfix)
- if you don't have an issue_id change it to the pr id after creating the PR
- ensure type is one of the following:
  - .feature: Signifying a new feature.
  - .bugfix: Signifying a bug fix.
  - .doc: Signifying a documentation improvement.
  - .removal: Signifying a deprecation or removal of public API.
  - .misc: A ticket has been closed, but it is not of interest to users.
- Make sure to use full sentences with correct case and punctuation, for example: Fix issue with non-ascii contents in doctest text files.

I have found myself having to do explicit type conversions of `int` subclasses that should definitely work. This new check allows all `int` subclasses through except `bool`, which should obviously be rejected.

codecov · 2020-08-08T13:57:25Z

Codecov Report

Merging #492 into master will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##           master     #492   +/-   ##
=======================================
  Coverage   99.57%   99.57%           
=======================================
  Files           4        4           
  Lines         708      712    +4     
  Branches      157      158    +1     
=======================================
+ Hits          705      709    +4     
  Misses          3        3

Impacted Files	Coverage Δ
yarl/_url.py	`99.44% <100.00%> (+<0.01%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update aa14d56...f1038da. Read the comment docs.

webknjaz · 2020-08-09T09:36:15Z

        if isinstance(v, str):
            return v
-        if type(v) is int:  # no subclasses like bool
+        if isinstance(v, int) and not isinstance(v, bool):  # no subclasses like bool


This will probably make it slower so I'll leave it to @asvetlov to decide. But you'd probably have to add tests for this (both negative and positive) and find other places in code that use the same idiom.

Also, what if such int subclass implements a weird __str__() method that returns something odd? This would create hard-to-debug issues in the calling code, especially if your colleagues don't know YARL internals. Is it really worth it? This could probably be mitigated by an extra check for v.__str__ is int.__str__ but isn't it overkill?

asvetlov · 2020-08-10T10:33:44Z

Would you describe your use case?

Exahilosys · 2020-08-10T13:07:19Z

@webknjaz I can add tests, please allow for some time as I'm currently on holiday. Also, instead of using the built-in str for conversion, int.__str__ could directly be used (no need to compare __str__s then). This does't feel overkill and makes conversion more consistent across the board.

@asvetlov I am making a package with a subclass of int meant to represent ids following twitter's snowflake standard with custom methods for extracting information like worker ids and timestamps. Those ids point to API resources and are sometimes used in the query part of requests.

Since aiohttp uses yarl under the hood, explicit conversions from that int subclass to str or int are required every time. Situations like this are what this PR is trying to address.

Exahilosys · 2020-08-17T10:43:05Z

I have created both positive and negative tests by restructuring and expanding the current type-checking strategy to a more compact one. As an extra to the PR, I would also suggest allowing float subclasses.

serhiy-storchaka · 2020-09-23T08:53:59Z

The most common int subclasses are bool and IntEnum. bool is not allowed in query because of ambiguity of its representation: 1/0, true/false, True/False, yes/no, on/off, etc. But IntEnum also overrides __str__, so there is ambiguity of its representation: as MsgFlag.MSG_CONFIRM or 2048? And the representation of standard enums may be changed in Python 3.10, so it will be socket.MSG_CONFIRM.

asvetlov · 2020-09-23T16:04:33Z

Fixed by #505

asvetlov · 2020-09-23T16:05:06Z

@Exahilosys thanks for the initial PR!
I've slightly improved it and merged.

Fix dependencies. 1.6.0 (2020-09-23) ================== Features -------- - Allow for int and float subclasses in query, while still denying bool. `#492 <https://github.com/aio-libs/yarl/issues/492>`_ Bugfixes -------- - Do not requote arguments in ``URL.build()``, ``with_xxx()`` and in ``/`` operator. `#502 <https://github.com/aio-libs/yarl/issues/502>`_ - Keep IPv6 brackets in ``origin()``. `#504 <https://github.com/aio-libs/yarl/issues/504>`_

https://build.opensuse.org/request/show/838272 by user dirkmueller + dimstar_suse - update to 1.6.0: - Allow for int and float subclasses in query, while still denying bool. `#492 <https://github.com/aio-libs/yarl/issues/492>`_ - Do not requote arguments in ``URL.build()``, ``with_xxx()`` and in ``/`` operator. `#502 <https://github.com/aio-libs/yarl/issues/502>`_ - Keep IPv6 brackets in ``origin()``. `#504 <https://github.com/aio-libs/yarl/issues/504>`_

Allow int Subclasses in Query

eaddc6f

I have found myself having to do explicit type conversions of `int` subclasses that should definitely work. This new check allows all `int` subclasses through except `bool`, which should obviously be rejected.

webknjaz reviewed Aug 9, 2020

View reviewed changes

Exahilosys added 3 commits August 17, 2020 12:51

Allow float Subclasses in Query

de3e902

Add Tests for New Query Types

3ba730e

Added News Fragment

83be698

psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Aug 17, 2020

Exahilosys added 3 commits August 17, 2020 13:06

Linted Code

e7c089f

Use cls and int.__str__

262b486

Added Weird __str__ and Finity Checks and Tests

f1038da

asvetlov mentioned this pull request Sep 23, 2020

Allow int and float Subclasses in Query #505

Merged

asvetlov closed this Sep 23, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Allow int Subclasses in Query#492

Allow int Subclasses in Query#492
Exahilosys wants to merge 7 commits intoaio-libs:masterfrom
Exahilosys:patch-1

Exahilosys commented Aug 8, 2020 •

edited

Loading

Uh oh!

codecov bot commented Aug 8, 2020 •

edited

Loading

Uh oh!

webknjaz Aug 9, 2020

Uh oh!

asvetlov commented Aug 10, 2020

Uh oh!

Exahilosys commented Aug 10, 2020

Uh oh!

Exahilosys commented Aug 17, 2020

Uh oh!

serhiy-storchaka commented Sep 23, 2020

Uh oh!

asvetlov commented Sep 23, 2020

Uh oh!

asvetlov commented Sep 23, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

Exahilosys commented Aug 8, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What do these changes do?

Are there changes in behavior for the user?

Checklist

Uh oh!

codecov bot commented Aug 8, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

webknjaz Aug 9, 2020

Choose a reason for hiding this comment

Uh oh!

asvetlov commented Aug 10, 2020

Uh oh!

Exahilosys commented Aug 10, 2020

Uh oh!

Exahilosys commented Aug 17, 2020

Uh oh!

serhiy-storchaka commented Sep 23, 2020

Uh oh!

asvetlov commented Sep 23, 2020

Uh oh!

asvetlov commented Sep 23, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Exahilosys commented Aug 8, 2020 •

edited

Loading

codecov bot commented Aug 8, 2020 •

edited

Loading