Skip to content

for IDE auto-complete with global Wrapper#201

Merged
you-n-g merged 2 commits intomicrosoft:mainfrom
bidfit:type_D_R
Jan 20, 2021
Merged

for IDE auto-complete with global Wrapper#201
you-n-g merged 2 commits intomicrosoft:mainfrom
bidfit:type_D_R

Conversation

@GoooIce
Copy link
Contributor

@GoooIce GoooIce commented Jan 20, 2021

R, D, Cal, Inst, FeatureD, ExpressionD, DatasetD, D

Description

qlib/data/data.py

import sys

if sys.version_info >= (3, 9):
    from typing import Annotated

    CalendarProviderWrapper = Annotated[CalendarProvider, Wrapper]
    InstrumentProviderWrapper = Annotated[InstrumentProvider, Wrapper]
    FeatureProviderWrapper = Annotated[FeatureProvider, Wrapper]
    ExpressionProviderWrapper = Annotated[ExpressionProvider, Wrapper]
    DatasetProviderWrapper = Annotated[DatasetProvider, Wrapper]
    BaseProviderWrapper = Annotated[BaseProvider, Wrapper]
else:
    CalendarProviderWrapper = CalendarProvider
    InstrumentProviderWrapper = InstrumentProvider
    FeatureProviderWrapper = FeatureProvider
    ExpressionProviderWrapper = ExpressionProvider
    DatasetProviderWrapper = DatasetProvider
    BaseProviderWrapper = BaseProvider

Cal: CalendarProviderWrapper = Wrapper()
Inst: InstrumentProviderWrapper = Wrapper()
FeatureD: FeatureProviderWrapper = Wrapper()
ExpressionD: ExpressionProviderWrapper = Wrapper()
DatasetD: DatasetProviderWrapper = Wrapper()
D: BaseProviderWrapper = Wrapper()

qlib/workflow/init.py

import sys

if sys.version_info >= (3, 9):
    from typing import Annotated

    QlibRecorderWrapper = Annotated[QlibRecorder, Wrapper]
else:
    QlibRecorderWrapper = QlibRecorder

# global record
R: QlibRecorderWrapper = Wrapper()

Motivation and Context

How Has This Been Tested?

  • Pass the test by running: pytest qlib/tests/test_all_pipeline.py under upper directory of qlib.
  • If you are adding a new feature, test on your own test scripts.

Screenshots of Test Results (if appropriate):

  1. Pipeline test:
  2. Your own tests:

Types of changes

  • Fix bugs
  • Add new feature
  • Update documentation

R, D, Cal, Inst, FeatureD, ExpressionD, DatasetD, D
D = Wrapper()
import sys

if sys.version_info >= (3, 9):
Copy link
Collaborator

Choose a reason for hiding this comment

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

Will it work if Union is used instead of Annotated?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

    CalendarProviderWrapper = Union[CalendarProvider, Wrapper]
    Cal: CalendarProviderWrapper = Wrapper()

will got an Cal with Type[Wrapper], IDE didn't work.

@you-n-g
Copy link
Collaborator

you-n-g commented Jan 20, 2021

@GoooIce
I looks great. You are realy solving a issue that haunts me for a long time.
Thanks.

@you-n-g you-n-g merged commit 784e73b into microsoft:main Jan 20, 2021
you-n-g added a commit to you-n-g/qlib that referenced this pull request Aug 16, 2025
* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants