diff --git a/docs/api/configurations/data_types.md b/docs/api/configurations/data_types.md index 5dc85a362e..c75c754cdb 100644 --- a/docs/api/configurations/data_types.md +++ b/docs/api/configurations/data_types.md @@ -999,7 +999,8 @@ def __init__(name: Union[PyPIPackageName, str], version: Union[str, SpecifierSet] = "", index: Optional[str] = None, git: Optional[str] = None, - ref: Optional[Union[GitRef, str]] = None) -> None + ref: Optional[Union[GitRef, str]] = None, + extras: Optional[List[str]] = None) -> None ``` Initialize a PyPI dependency. @@ -1011,6 +1012,7 @@ Initialize a PyPI dependency. - `index`: the URL to the PyPI server. - `git`: the URL to a git repository. - `ref`: the Git reference (branch/commit/tag). +- `extras`: Include extras section for the dependency. @@ -1067,6 +1069,28 @@ def ref() -> Optional[str] Get the ref. + + +#### extras + +```python +@property +def extras() -> List[str] +``` + +Get the ref. + + + +#### from`_`pipfile`_`string + +```python +@classmethod +def from_pipfile_string(cls, string: str) -> "Dependency" +``` + +Parse from Pipfile version specifier. + #### from`_`string @@ -1099,6 +1123,26 @@ def to_json() -> Dict[str, Dict[str, str]] Transform the object to JSON. + + +#### to`_`pip`_`string + +```python +def to_pip_string() -> str +``` + +To pip specifier. + + + +#### to`_`pipfile`_`string + +```python +def to_pipfile_string() -> str +``` + +To Pipfile specifier. + #### get`_`pip`_`install`_`args