Skip to content

Replace doc in stata #62668

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

Merged
merged 3 commits into from
Oct 16, 2025
+29 −9
Merged

Replace doc in stata #62668

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
774b712
Replace the @doc placeholders with text
JuanCarlos3 Oct 12, 2025
0e48820
Removed usages of doc decorator:
JuanCarlos3 Oct 12, 2025
cbe65ce
Fix syntax for dictionary literals in StataWriter docstring examples …
JuanCarlos3 Oct 15, 2025
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
38 changes: 29 additions & 9 deletions pandas/io/stata.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@
ValueLabelTypeMismatch,
)
from pandas.util._decorators import (
doc,
set_module,
)
from pandas.util._exceptions import find_stack_level
Expand Down Expand Up @@ -2377,10 +2376,6 @@ def _dtype_to_default_stata_fmt(
raise NotImplementedError(f"Data type {dtype} not supported.")


@doc(
storage_options=_shared_docs["storage_options"],
compression_options=_shared_docs["compression_options"] % "fname",
)
class StataWriter(StataParser):
"""
A class for writing Stata binary dta files
Expand Down Expand Up @@ -2412,11 +2407,36 @@ class StataWriter(StataParser):
variable_labels : dict
Dictionary containing columns as keys and variable labels as values.
Each label must be 80 characters or smaller.
{compression_options}
compression : str or dict, default 'infer'
For on-the-fly compression of the output data. If 'infer' and 'fname' is
path-like, then detect compression from the following extensions: '.gz',
'.bz2', '.zip', '.xz', '.zst', '.tar', '.tar.gz', '.tar.xz' or '.tar.bz2'
(otherwise no compression).
Set to ``None`` for no compression.
Can also be a dict with key ``'method'`` set
to one of {``'zip'``, ``'gzip'``, ``'bz2'``, ``'zstd'``, ``'xz'``, ``'tar'``}
and other key-value pairs are forwarded to
``zipfile.ZipFile``, ``gzip.GzipFile``,
``bz2.BZ2File``, ``zstandard.ZstdCompressor``, ``lzma.LZMAFile`` or
``tarfile.TarFile``, respectively.
As an example, the following could be passed for faster compression and to
create a reproducible gzip archive:
``compression={'method': 'gzip', 'compresslevel': 1, 'mtime': 1}``.

.. versionadded:: 1.5.0
Added support for `.tar` files.

.. versionchanged:: 1.4.0 Zstandard support.

{storage_options}
storage_options : dict, optional
Extra options that make sense for a particular storage connection, e.g.
host, port, username, password, etc. For HTTP(S) URLs the key-value pairs
are forwarded to ``urllib.request.Request`` as header options. For other
URLs (e.g. starting with "s3://", and "gcs://") the key-value pairs are
forwarded to ``fsspec.open``. Please see ``fsspec`` and ``urllib`` for more
details, and for more examples on storage options refer `here
<https://pandas.pydata.org/docs/user_guide/io.html?
highlight=storage_options#reading-writing-remote-files>`_.

value_labels : dict of dicts
Dictionary containing columns as keys and dictionaries of column value
Expand Down Expand Up @@ -2449,14 +2469,14 @@ class StataWriter(StataParser):
>>> writer.write_file()

Directly write a zip file
>>> compression = {{"method": "zip", "archive_name": "data_file.dta"}}
>>> compression = {"method": "zip", "archive_name": "data_file.dta"}
>>> writer = StataWriter("./data_file.zip", data, compression=compression)
>>> writer.write_file()

Save a DataFrame with dates
>>> from datetime import datetime
>>> data = pd.DataFrame([[datetime(2000, 1, 1)]], columns=["date"])
>>> writer = StataWriter("./date_data_file.dta", data, {{"date": "tw"}})
>>> writer = StataWriter("./date_data_file.dta", data, {"date": "tw"})
>>> writer.write_file()
"""

Expand Down
Loading