Method read

pandas/io/stata.py:1601–1777

Reads observations from Stata file, converting them into a dataframe Parameters ---------- nrows : int Number of lines to read from data file, if None read whole file. convert_dates : bool, default True Convert date variables to DataF

(
        self,
        nrows: int | None = None,
        convert_dates: bool | None = None,
        convert_categoricals: bool | None = None,
        index_col: str | None = None,
        convert_missing: bool | None = None,
        preserve_dtypes: bool | None = None,
        columns: Sequence[str] | None = None,
        order_categoricals: bool | None = None,
    )

        return self.read(nrows=size)

    def read(
        self,
        nrows: int | None = None,
        convert_dates: bool | None = None,
        convert_categoricals: bool | None = None,
        index_col: str | None = None,
        convert_missing: bool | None = None,
        preserve_dtypes: bool | None = None,
        columns: Sequence[str] | None = None,
        order_categoricals: bool | None = None,
    ) -> DataFrame:
        """
        Reads observations from Stata file, converting them into a dataframe

        Parameters
        ----------
        nrows : int
            Number of lines to read from data file, if None read whole file.
        convert_dates : bool, default True
            Convert date variables to DataFrame time values.
        convert_categoricals : bool, default True
            Read value labels and convert columns to Categorical/Factor variables.
        index_col : str, optional
            Column to set as index.
        convert_missing : bool, default False
            Flag indicating whether to convert missing values to their Stata
            representations.  If False, missing values are replaced with nan.
            If True, columns containing missing values are returned with
            object data types and missing values are represented by
            StataMissingValue objects.
        preserve_dtypes : bool, default True
            Preserve Stata datatypes. If False, numeric data are upcast to pandas
            default types for foreign data (float64 or int64).
        columns : list or None
            Columns to retain.  Columns will be returned in the given order.  None
            returns all columns.
        order_categoricals : bool, default True
            Flag indicating whether converted categorical data are ordered.

        Returns
        -------
        DataFrame
        """
        self._ensure_open()

        # Handle options
        if convert_dates is None:
            convert_dates = self._convert_dates
        if convert_categoricals is None:
            convert_categoricals = self._convert_categoricals
        if convert_missing is None:
            convert_missing = self._convert_missing
        if preserve_dtypes is None:
            preserve_dtypes = self._preserve_dtypes
        if columns is None:
            columns = self._columns
        if order_categoricals is None:
            order_categoricals = self._order_categoricals