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.

Sign up for GitHub

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

docs(python): Add storage_options hint for azure #18990

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+24 −0
Open

docs(python): Add storage_options hint for azure #18990

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f0faf30
docs: add storage_options hint for azure
Sep 28, 2024
f690b5a
fix: fix line length
Sep 28, 2024
2b2ec25
fix: remove trailing white spaces
Sep 28, 2024
143d64e
fix: line length
Sep 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions py-polars/polars/io/csv/functions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1146,6 +1146,10 @@ def scan_csv(
* `aws <https://docs.rs/object_store/latest/object_store/aws/enum.AmazonS3ConfigKey.html>`_
* `gcp <https://docs.rs/object_store/latest/object_store/gcp/enum.GoogleConfigKey.html>`_
* `azure <https://docs.rs/object_store/latest/object_store/azure/enum.AzureConfigKey.html>`_
(hint: `{"account_name": "<ACCOUNT_NAME>"}`
to use the underlying azure infrastructure identity,
`{"account_name": "<ACCOUNT_NAME>", "use_azure_cli": "True"}`
to use the identity specified in `az login`)
* Hugging Face (`hf://`): Accepts an API key under the `token` parameter: \
`{'token': '...'}`, or by setting the `HF_TOKEN` environment variable.

Expand Down
4 changes: 4 additions & 0 deletions py-polars/polars/io/ipc/functions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -402,6 +402,10 @@ def scan_ipc(
* `aws <https://docs.rs/object_store/latest/object_store/aws/enum.AmazonS3ConfigKey.html>`_
* `gcp <https://docs.rs/object_store/latest/object_store/gcp/enum.GoogleConfigKey.html>`_
* `azure <https://docs.rs/object_store/latest/object_store/azure/enum.AzureConfigKey.html>`_
(hint: `{"account_name": "<ACCOUNT_NAME>"}`
to use the underlying azure infrastructure identity,
`{"account_name": "<ACCOUNT_NAME>", "use_azure_cli": "True"}`
to use the identity specified in `az login`)
* Hugging Face (`hf://`): Accepts an API key under the `token` parameter: \
`{'token': '...'}`, or by setting the `HF_TOKEN` environment variable.

Expand Down
8 changes: 8 additions & 0 deletions py-polars/polars/io/ndjson.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,10 @@ def read_ndjson(
* `aws <https://docs.rs/object_store/latest/object_store/aws/enum.AmazonS3ConfigKey.html>`_
* `gcp <https://docs.rs/object_store/latest/object_store/gcp/enum.GoogleConfigKey.html>`_
* `azure <https://docs.rs/object_store/latest/object_store/azure/enum.AzureConfigKey.html>`_
(hint: `{"account_name": "<ACCOUNT_NAME>"}`
to use the underlying azure infrastructure identity,
`{"account_name": "<ACCOUNT_NAME>", "use_azure_cli": "True"}`
to use the identity specified in `az login`)
* Hugging Face (`hf://`): Accepts an API key under the `token` parameter: \
`{'token': '...'}`, or by setting the `HF_TOKEN` environment variable.

Expand Down Expand Up @@ -244,6 +248,10 @@ def scan_ndjson(
* `aws <https://docs.rs/object_store/latest/object_store/aws/enum.AmazonS3ConfigKey.html>`_
* `gcp <https://docs.rs/object_store/latest/object_store/gcp/enum.GoogleConfigKey.html>`_
* `azure <https://docs.rs/object_store/latest/object_store/azure/enum.AzureConfigKey.html>`_
(hint: `{"account_name": "<ACCOUNT_NAME>"}`
to use the underlying azure infrastructure identity,
`{"account_name": "<ACCOUNT_NAME>", "use_azure_cli": "True"}`
to use the identity specified in `az login`)
* Hugging Face (`hf://`): Accepts an API key under the `token` parameter: \
`{'token': '...'}`, or by setting the `HF_TOKEN` environment variable.

Expand Down
8 changes: 8 additions & 0 deletions py-polars/polars/io/parquet/functions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,10 @@ def read_parquet(
* `aws <https://docs.rs/object_store/latest/object_store/aws/enum.AmazonS3ConfigKey.html>`_
* `gcp <https://docs.rs/object_store/latest/object_store/gcp/enum.GoogleConfigKey.html>`_
* `azure <https://docs.rs/object_store/latest/object_store/azure/enum.AzureConfigKey.html>`_
(hint: `{"account_name": "<ACCOUNT_NAME>"}`
to use the underlying azure infrastructure identity,
`{"account_name": "<ACCOUNT_NAME>", "use_azure_cli": "True"}`
to use the identity specified in `az login`)
* Hugging Face (`hf://`): Accepts an API key under the `token` parameter: \
`{'token': '...'}`, or by setting the `HF_TOKEN` environment variable.

Expand Down Expand Up @@ -388,6 +392,10 @@ def scan_parquet(
* `aws <https://docs.rs/object_store/latest/object_store/aws/enum.AmazonS3ConfigKey.html>`_
* `gcp <https://docs.rs/object_store/latest/object_store/gcp/enum.GoogleConfigKey.html>`_
* `azure <https://docs.rs/object_store/latest/object_store/azure/enum.AzureConfigKey.html>`_
(hint: `{"account_name": "<ACCOUNT_NAME>"}`
to use the underlying azure infrastructure identity,
`{"account_name": "<ACCOUNT_NAME>", "use_azure_cli": "True"}`
to use the identity specified in `az login`)
* Hugging Face (`hf://`): Accepts an API key under the `token` parameter: \
`{'token': '...'}`, or by setting the `HF_TOKEN` environment variable.

Expand Down
Loading