Rename private modules with leading underscore #2687

kencx · 2021-10-01T16:28:40Z

I also standardized some of the module imports, except in cases of circular imports.

Changes

Rename private modules in telegram package
Rename private modules in telegram.ext package
Rename telegram(.ext).utils to telegram(.ext)._utils

Todo

Update, if Builder pattern for ext #2646 or Refactor how InputMedia* subclasses handle inits #2573 is merged first

…ryptionError (python-telegram-bot#2621) * move telegramdecryptionerror to error.py * Change error class name

…t#2612) * feat: add docs about docs * fix: improve looks * fix: make link work * fix: this looks better * Improved markdown, updated link * Less justifying Co-authored-by: Bibo-Joshi <22366557+Bibo-Joshi@users.noreply.github.com>

* Fix incomplete type annotations for CallbackContext Co-authored-by: Hinrich Mahler <22366557+Bibo-Joshi@users.noreply.github.com>

* Feat: Custom pytest marker Co-authored-by: Bibo-Joshi <22366557+Bibo-Joshi@users.noreply.github.com>

* Make basepersistence methods abstractmethod Signed-off-by: starry69 <starry369126@outlook.com> Co-authored-by: Hinrich Mahler <22366557+Bibo-Joshi@users.noreply.github.com>

)

…am-bot#2619, python-telegram-bot#2636)

…m-bot#2634) Co-authored-by: Hinrich Mahler <22366557+Bibo-Joshi@users.noreply.github.com>

python-telegram-bot#2657)

Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com>

Files that contain imported classes in `__init__` are considered private. This is in accordance with PEP8. The modules `chat, message, user, callbackquery, inline.inlinequery, passport.credentials, passport.passportdata, passport.passportfile, payment.precheckoutquery, payment.shippingquery` have not be renamed due to type checking issues.

Resolves type checking issues from previous commit.

telegram/ext/extbot.py

All mnodules have been renamed except telegram.ext.filters

Bibo-Joshi

The DeepSource fail is unrelated - should work on the next commit. Please make sure to merge v14 into your branch, since there are currently merge conflicts :)

telegram/__init__.py

telegram/ext/_dispatcher.py

telegram._{files, games, inline, passport, payment} are renamed.

github-actions

Hey! Looks like you edited README.rst or README_RAW.rst. I'm just a friendly reminder to apply relevant changes to both of those files :)

github-actions

Hey! Looks like you edited the (dev) requirements or the pre-commit hooks. I'm just a friendly reminder to keep the pre-commit hook versions in sync with the dev requirements and the additional dependencies for the hooks in sync with the requirements :)

github-actions

Hey there. Relax, I am just a little warning for the maintainers to release directly after merging your PR, otherwise we have broken examples and people might get confused :)

…dules

kencx · 2021-10-07T05:12:28Z

Hi @Bibo-Joshi, I would be happy to update the documentation with the discussed changes. However, I am a little unsure of what you mean by removing all mentions of (ext)._utils.

For example, in BasePersistence , do we remove all mentions of the custom typing aliases, leaving just a description?

A proposed example:

abstract get_user_data()
    Will be called by telegram.ext.Dispatcher upon creation with a persistence object. It should return the user_data if stored.
    
    Returns
        The restored user data.
    Return type
        DefaultDict[int]

Bibo-Joshi · 2021-10-07T07:12:02Z

Hi @Bibo-Joshi, I would be happy to update the documentation with the discussed changes

Sweet :) 👍

However, I am a little unsure of what you mean by removing all mentions of (ext)._utils.

Right, the persistence case is indeed a bit tricky. The point here is that in the usual case get_user_data should return a Dict[int, Dict], becaues context.user_data is usually of type Dict. However, if ContextTypes are used, then the it should return a Dict[int, context_types.user_data]. Maybe this can be formulated along the lines

abstract get_user_data()
    Will be called by telegram.ext.Dispatcher upon creation with a persistence object. It should return the user_data if stored, or an empty defaultdict. In the latter case, the defaultdict should produce values that correspond to the expected type of CallbackContext.user_data, which usually is simply dict unless ContextTypes are used.
    
    Returns
        The restored user data.
    Return type
        DefaultDict[int, Dict/Type specified by ContextTypes.user_data]

This is just a quick draft - feel free to reformulate :) A similar logic can be used for the other TypeVars in (.ext)._utils, i.e. describing which type is expected.
For type aliases (CDCData and ConversationDict), it should suffice to insert the actual type into the docs, replace ext._utils.ConversationDict with Dict[Tuple[:obj:`int`, ...], Optional[:obj:`object`]]

I hope this helps you get started :) If you have any questions, feel free to ping me here or on Telegram (@BiboJoshi)

kencx · 2021-10-09T10:41:18Z

All mentions of tg.(ext)._utils modules should have been removed, but please let me know if I missed any.

The changes also follow the discussed scheme, and I hope I haven't altered any key phrasing or meanings. Let know me if anything could be worded better and I would be happy to edit it :)

telegram/ext/_basepersistence.py

telegram/ext/_dictpersistence.py

telegram/ext/_utils/types.py

Bibo-Joshi

Thanks for the updates! I left a few more nitpicks below :)

telegram/ext/_basepersistence.py

kencx · 2021-10-10T04:26:58Z

The past 4 commits have very similar messages as I didn't really know what to name them after the first one. Maybe we can squash them into 1 commit after all further documentation changes have been made?

Bibo-Joshi

I think I'm happy now :) THanks for your patience @kennethcheo! If @harshil21 gives a LGTM as well, we can rebase on v14, adapt to the changes of #2646 and merge :)

harshil21

last one

telegram/ext/_basepersistence.py

Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com>

harshil21

lgtm!

# Conflicts: # docs/source/telegram.ext.rst # telegram/ext/__init__.py # telegram/ext/_callbackcontext.py # telegram/ext/_contexttypes.py # telegram/ext/_dispatcher.py # telegram/ext/_updater.py # tests/test_dispatcher.py # tests/test_persistence.py # tests/test_updater.py

Bibo-Joshi · 2021-10-10T13:10:34Z

Thank you for the contribution @kennethcheo :)

Bibo-Joshi and others added 19 commits September 15, 2021 17:09

Temporarily enable tests for the v14 branch

331c4f5

Move and Rename TelegramDecryptionError to telegram.error.PassportDec…

9dc30cf

…ryptionError (python-telegram-bot#2621) * move telegramdecryptionerror to error.py * Change error class name

Improve Type Hinting for CallbackContext (python-telegram-bot#2587)

3a19383

* Fix incomplete type annotations for CallbackContext Co-authored-by: Hinrich Mahler <22366557+Bibo-Joshi@users.noreply.github.com>

Add Custom pytest Marker to Ease Development (python-telegram-bot#2628)

414a18c

* Feat: Custom pytest marker Co-authored-by: Bibo-Joshi <22366557+Bibo-Joshi@users.noreply.github.com>

Make BasePersistence Methods Abstract (python-telegram-bot#2624)

8edb49d

* Make basepersistence methods abstractmethod Signed-off-by: starry69 <starry369126@outlook.com> Co-authored-by: Hinrich Mahler <22366557+Bibo-Joshi@users.noreply.github.com>

Refactor Initialization of Persistence Classes (python-telegram-bot#2604

cce9c18

)

Remove __dict__ from __slots__ and drop Python 3.6 (python-telegr…

dc0207a

…am-bot#2619, python-telegram-bot#2636)

Remove day_is_strict argument of JobQueue.run_monthly (python-telegra…

4af252f

…m-bot#2634) Co-authored-by: Hinrich Mahler <22366557+Bibo-Joshi@users.noreply.github.com>

Drop Non-CallbackContext API (python-telegram-bot#2617)

b6e4b54

Fix Signatures and Improve test_official (python-telegram-bot#2643)

4359812

Remove Deprecated Functionality (python-telegram-bot#2644)

dbdd35e

Add User Friendly Type Check For Init Of {Inline, Reply}KeyboardMarkup (

a7c7c82

python-telegram-bot#2657)

Refine Dispatcher.dispatch_error (python-telegram-bot#2660)

8ac65fc

Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com>

Warnings Overhaul (python-telegram-bot#2662)

66f0604

Clear Up Import Policy (python-telegram-bot#2671)

4f21c06

Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com>

Make InlineQuery.answer Raise ValueError (python-telegram-bot#2675)

5542a46

Rename all private modules with leading underscore

e9b54df

Resolves type checking issues from previous commit.

kencx changed the title ~~Private modules~~ Rename private modules with leading underscore Oct 1, 2021

Bibo-Joshi marked this pull request as draft October 1, 2021 19:08

Bibo-Joshi reviewed Oct 1, 2021

View reviewed changes

telegram/ext/extbot.py Outdated Show resolved Hide resolved

Rename private modules in telegram.ext with leading underscore

0962e45

All mnodules have been renamed except telegram.ext.filters

Bibo-Joshi requested changes Oct 2, 2021

View reviewed changes

telegram/__init__.py Outdated Show resolved Hide resolved

telegram/ext/_dispatcher.py Outdated Show resolved Hide resolved

Bibo-Joshi force-pushed the v14 branch from b79487d to 2c44dc0 Compare October 3, 2021 18:18

Bibo-Joshi mentioned this pull request Oct 3, 2021

Builder pattern for ext #2646

Merged

6 tasks

Rename private submodules with leading underscore

b2b074d

telegram._{files, games, inline, passport, payment} are renamed.

github-actions bot reviewed Oct 4, 2021

View reviewed changes

Bibo-Joshi added the 📋 pending-reply work status: pending-reply label Oct 6, 2021

Merge remote-tracking branch 'origin/private-modules' into private-mo…

4de323a

…dules

harshil21 added this to the v14 milestone Oct 7, 2021

harshil21 added the 🛠 refactor change type: refactor label Oct 7, 2021

Remove mentions of contents in (ext)._utils from documentation

e76639b

harshil21 requested changes Oct 9, 2021

View reviewed changes

Minor fixes to formatting in documentation

7db65b0

Bibo-Joshi requested changes Oct 9, 2021

View reviewed changes

telegram/ext/_basepersistence.py Outdated Show resolved Hide resolved

telegram/ext/_basepersistence.py Outdated Show resolved Hide resolved

telegram/ext/_basepersistence.py Outdated Show resolved Hide resolved

More minor fixes to documentation

b7bb161

harshil21 reviewed Oct 9, 2021

View reviewed changes

telegram/ext/_basepersistence.py Outdated Show resolved Hide resolved

Minor fix to documentation

2add52b

Bibo-Joshi removed the 📋 pending-reply work status: pending-reply label Oct 10, 2021

Bibo-Joshi approved these changes Oct 10, 2021

View reviewed changes

Bibo-Joshi mentioned this pull request Oct 10, 2021

A bit more pathlib #2724

Merged

harshil21 requested changes Oct 10, 2021

View reviewed changes

telegram/ext/_basepersistence.py Outdated Show resolved Hide resolved

Fix minor typo in ext.basepersistence.py

3a66a77

Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com>

harshil21 approved these changes Oct 10, 2021

View reviewed changes

Bibo-Joshi added 3 commits October 10, 2021 14:09

Fix tests

18308bd

Some last fine tuning

fc284e8

Bibo-Joshi merged commit eec90a0 into python-telegram-bot:v14 Oct 10, 2021

eldbud mentioned this pull request Oct 10, 2021

Input media subclasses init handling refactor #2573 #2717

Merged

zpavloudis mentioned this pull request Oct 10, 2021

[REFACTOR] Shortcut bots handling #2712

Merged

7 tasks

github-actions bot locked and limited conversation to collaborators Oct 11, 2021

harshil21 added the hacktoberfest-accepted other: hacktoberfest-accepted label Oct 30, 2021

Rename private modules with leading underscore #2687

Rename private modules with leading underscore #2687

Uh oh!

Conversation

kencx commented Oct 1, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Todo

Uh oh!

Uh oh!

Bibo-Joshi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

kencx commented Oct 7, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Bibo-Joshi commented Oct 7, 2021

Uh oh!

kencx commented Oct 9, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Bibo-Joshi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kencx commented Oct 10, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Bibo-Joshi left a comment

Choose a reason for hiding this comment

Uh oh!

harshil21 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

harshil21 left a comment

Choose a reason for hiding this comment

Uh oh!

Bibo-Joshi commented Oct 10, 2021

Uh oh!

Uh oh!

kencx commented Oct 1, 2021 •

edited

Loading

kencx commented Oct 7, 2021 •

edited

Loading

kencx commented Oct 10, 2021 •

edited

Loading