Skip to content
This repository was archived by the owner on Feb 2, 2024. It is now read-only.

Correction doc for some Series.str methods #462

Merged
merged 11 commits into from
Jan 4, 2020
Merged

Correction doc for some Series.str methods #462

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
0d46c6e
correction doc
Rubtsowa Dec 30, 2019
2df39f5
Merge branch 'master' of https://github.com/IntelPython/hpat into doc…
Rubtsowa Dec 30, 2019
d1dd95a
correction doc
Rubtsowa Dec 30, 2019
33f9c28
use of cycle
Rubtsowa Dec 31, 2019
87aeedb
Merge branch 'master' of https://github.com/IntelPython/hpat into doc…
Rubtsowa Dec 31, 2019
cab1d66
correction doc, add captions
Rubtsowa Dec 31, 2019
06dec3a
Merge branch 'master' of https://github.com/IntelPython/hpat into doc…
Rubtsowa Dec 31, 2019
70235cf
correction dict for doc
Rubtsowa Dec 31, 2019
8ec8195
correction problem with PEP8
Rubtsowa Dec 31, 2019
3f89c58
Merge branch 'master' of https://github.com/IntelPython/hpat into doc…
Rubtsowa Dec 31, 2019
11b5f34
Merge branch 'master' of https://github.com/IntelPython/hpat into doc…
Rubtsowa Dec 31, 2019
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
2 changes: 1 addition & 1 deletion sdc/datatypes/hpat_pandas_series_functions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,7 @@ def hpat_pandas_series_setitem(self, idx, value):
"""
Intel Scalable Dataframe Compiler User Guide
********************************************
Pandas API: pandas.Series.set
Pandas API: pandas.Series.__setitem__

Examples
--------
Expand Down
289 changes: 33 additions & 256 deletions sdc/datatypes/hpat_pandas_stringmethods_functions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -913,27 +913,25 @@ def _hpat_pandas_stringmethods_autogen(method_name):
return _hpat_pandas_stringmethods_autogen_global_dict[global_dict_name]


@overload_method(StringMethodsType, 'istitle')
def hpat_pandas_stringmethods_istitle(self):
"""
sdc_pandas_series_str_docstring_template = """
Intel Scalable Dataframe Compiler User Guide
********************************************
Pandas API: pandas.Series.str.istitle
Pandas API: pandas.Series.str.{method_name}

Limitations
-----------
Series elements are expected to be Unicode strings. Elements cannot be NaN.

Examples
--------
.. literalinclude:: ../../../examples/series/str/series_str_istitle.py
.. literalinclude:: ../../../examples/series/str/series_str_{method_name}.py
:language: python
:lines: 27-
:caption: Check if each word start with an upper case letter
:name: ex_series_str_istitle
:caption: {caption}
:name: ex_series_str_{method_name}

.. command-output:: python ./series/str/series_str_istitle.py
:cwd: ../../../examples
.. command-output:: python ./series/str/series_str_{method_name}.py
:cwd: ../../../examples

.. seealso::
:ref:`Series.str.isalpha <pandas.Series.str.isalpha>`
Expand All @@ -958,13 +956,13 @@ def hpat_pandas_stringmethods_istitle(self):
Intel Scalable Dataframe Compiler Developer Guide
*************************************************

Pandas Series method :meth:`pandas.core.strings.StringMethods.istitle()` implementation.
Pandas Series method :meth:`pandas.core.strings.StringMethods.{method_name}()` implementation.

Note: Unicode type of list elements are supported only. Numpy.NaN is not supported as elements.

.. only:: developer

Test: python -m sdc.runtests sdc.tests.test_series.TestSeries.test_series_istitle_str
Test: python -m sdc.runtests sdc.tests.test_series.TestSeries.test_series_{method_name}_str

Parameters
----------
Expand All @@ -975,7 +973,11 @@ def hpat_pandas_stringmethods_istitle(self):
-------
:obj:`pandas.Series`
returns :obj:`pandas.Series` object
"""
"""


@overload_method(StringMethodsType, 'istitle')
def hpat_pandas_stringmethods_istitle(self):

ty_checker = TypeChecker('Method istitle().')
ty_checker.check(self, StringMethodsType)
Expand All @@ -993,67 +995,6 @@ def hpat_pandas_stringmethods_istitle_impl(self):

@overload_method(StringMethodsType, 'isspace')
def hpat_pandas_stringmethods_isspace(self):
"""
Intel Scalable Dataframe Compiler User Guide
********************************************
Pandas API: pandas.Series.str.isspace

Limitations
-----------
Series elements are expected to be Unicode strings. Elements cannot be NaN.

Examples
--------
.. literalinclude:: ../../../examples/series/str/series_str_isspace.py
:language: python
:lines: 27-
:caption: Check if all the characters in the text are whitespaces
:name: ex_series_str_isspace

.. command-output:: python ./series/str/series_str_isspace.py
:cwd: ../../../examples

.. seealso::
:ref:`Series.str.isalpha <pandas.Series.str.isalpha>`
Check whether all characters are alphabetic.
:ref:`Series.str.isnumeric <pandas.Series.str.isnumeric>`
Check whether all characters are numeric.
:ref:`Series.str.isalnum <pandas.Series.str.isalnum>`
Check whether all characters are alphanumeric.
:ref:`Series.str.isdigit <pandas.Series.str.isdigit>`
Check whether all characters are digits.
:ref:`Series.str.isdecimal <pandas.Series.str.isdecimal>`
Check whether all characters are decimal.
:ref:`Series.str.isspace <pandas.Series.str.isspace>`
Check whether all characters are whitespace.
:ref:`Series.str.islower <pandas.Series.str.islower>`
Check whether all characters are lowercase.
:ref:`Series.str.isupper <pandas.Series.str.isupper>`
Check whether all characters are uppercase.
:ref:`Series.str.istitle <pandas.Series.str.istitle>`
Check whether all characters are titlecase.

Intel Scalable Dataframe Compiler Developer Guide
*************************************************

Pandas Series method :meth:`pandas.core.strings.StringMethods.isspace()` implementation.

Note: Unicode type of list elements are supported only. Numpy.NaN is not supported as elements.

.. only:: developer

Test: python -m sdc.runtests sdc.tests.test_series.TestSeries.test_series_isspace_str

Parameters
----------
self: :class:`pandas.core.strings.StringMethods`
input arg

Returns
-------
:obj:`pandas.Series`
returns :obj:`pandas.Series` object
"""

ty_checker = TypeChecker('Method isspace().')
ty_checker.check(self, StringMethodsType)
Expand All @@ -1071,67 +1012,6 @@ def hpat_pandas_stringmethods_isspace_impl(self):

@overload_method(StringMethodsType, 'isalpha')
def hpat_pandas_stringmethods_isalpha(self):
"""
Intel Scalable Dataframe Compiler User Guide
********************************************
Pandas API: pandas.Series.str.isalpha

Limitations
-----------
Series elements are expected to be Unicode strings. Elements cannot be NaN.

Examples
--------
.. literalinclude:: ../../../examples/series/str/series_str_isalpha.py
:language: python
:lines: 27-
:caption: Check whether all characters in each string are alphabetic.
:name: ex_series_str_isalpha

.. command-output:: python ./series/str/series_str_isalpha.py
:cwd: ../../../examples

.. seealso::
:ref:`Series.str.isalpha <pandas.Series.str.isalpha>`
Check whether all characters are alphabetic.
:ref:`Series.str.isnumeric <pandas.Series.str.isnumeric>`
Check whether all characters are numeric.
:ref:`Series.str.isalnum <pandas.Series.str.isalnum>`
Check whether all characters are alphanumeric.
:ref:`Series.str.isdigit <pandas.Series.str.isdigit>`
Check whether all characters are digits.
:ref:`Series.str.isdecimal <pandas.Series.str.isdecimal>`
Check whether all characters are decimal.
:ref:`Series.str.isspace <pandas.Series.str.isspace>`
Check whether all characters are whitespace.
:ref:`Series.str.islower <pandas.Series.str.islower>`
Check whether all characters are lowercase.
:ref:`Series.str.isupper <pandas.Series.str.isupper>`
Check whether all characters are uppercase.
:ref:`Series.str.istitle <pandas.Series.str.istitle>`
Check whether all characters are titlecase.

Intel Scalable Dataframe Compiler Developer Guide
*************************************************

Pandas Series method :meth:`pandas.core.strings.StringMethods.isalpha()` implementation.

Note: Unicode type of list elements are supported only. Numpy.NaN is not supported as elements.

.. only:: developer

Test: python -m sdc.runtests sdc.tests.test_series.TestSeries.test_series_isalpha_str

Parameters
----------
self: :class:`pandas.core.strings.StringMethods`
input arg

Returns
-------
:obj:`pandas.Series`
returns :obj:`pandas.Series` object
"""

ty_checker = TypeChecker('Method isalpha().')
ty_checker.check(self, StringMethodsType)
Expand All @@ -1149,67 +1029,6 @@ def hpat_pandas_stringmethods_isalpha_impl(self):

@overload_method(StringMethodsType, 'islower')
def hpat_pandas_stringmethods_islower(self):
"""
Intel Scalable Dataframe Compiler User Guide
********************************************
Pandas API: pandas.Series.str.islower

Limitations
-----------
Series elements are expected to be Unicode strings. Elements cannot be NaN.

Examples
--------
.. literalinclude:: ../../../examples/series/str/series_str_islower.py
:language: python
:lines: 27-
:caption: Check if all the characters in the text are alphanumeric
:name: ex_series_str_islower

.. command-output:: python ./series/str/series_str_islower.py
:cwd: ../../../examples

.. seealso::
:ref:`Series.str.isalpha <pandas.Series.str.isalpha>`
Check whether all characters are alphabetic.
:ref:`Series.str.isnumeric <pandas.Series.str.isnumeric>`
Check whether all characters are numeric.
:ref:`Series.str.isalnum <pandas.Series.str.isalnum>`
Check whether all characters are alphanumeric.
:ref:`Series.str.isdigit <pandas.Series.str.isdigit>`
Check whether all characters are digits.
:ref:`Series.str.isdecimal <pandas.Series.str.isdecimal>`
Check whether all characters are decimal.
:ref:`Series.str.isspace <pandas.Series.str.isspace>`
Check whether all characters are whitespace.
:ref:`Series.str.islower <pandas.Series.str.islower>`
Check whether all characters are lowercase.
:ref:`Series.str.isupper <pandas.Series.str.isupper>`
Check whether all characters are uppercase.
:ref:`Series.str.istitle <pandas.Series.str.istitle>`
Check whether all characters are titlecase.

Intel Scalable Dataframe Compiler Developer Guide
*************************************************

Pandas Series method :meth:`pandas.core.strings.StringMethods.islower()` implementation.

Note: Unicode type of list elements are supported only. Numpy.NaN is not supported as elements.

.. only:: developer

Test: python -m sdc.runtests sdc.tests.test_series.TestSeries.test_series_islower_str

Parameters
----------
self: :class:`pandas.core.strings.StringMethods`
input arg

Returns
-------
:obj:`pandas.Series`
returns :obj:`pandas.Series` object
"""

ty_checker = TypeChecker('Method islower().')
ty_checker.check(self, StringMethodsType)
Expand All @@ -1227,67 +1046,6 @@ def hpat_pandas_stringmethods_islower_impl(self):

@overload_method(StringMethodsType, 'isalnum')
def hpat_pandas_stringmethods_isalnum(self):
"""
Intel Scalable Dataframe Compiler User Guide
********************************************
Pandas API: pandas.Series.str.isalnum

Limitations
-----------
Series elements are expected to be Unicode strings. Elements cannot be NaN.

Examples
--------
.. literalinclude:: ../../../examples/series/str/series_str_isalnum.py
:language: python
:lines: 27-
:caption: Check if all the characters in the text are alphanumeric
:name: ex_series_str_isalnum

.. command-output:: python ./series/str/series_str_isalnum.py
:cwd: ../../../examples

.. seealso::
:ref:`Series.str.isalpha <pandas.Series.str.isalpha>`
Check whether all characters are alphabetic.
:ref:`Series.str.isnumeric <pandas.Series.str.isnumeric>`
Check whether all characters are numeric.
:ref:`Series.str.isalnum <pandas.Series.str.isalnum>`
Check whether all characters are alphanumeric.
:ref:`Series.str.isdigit <pandas.Series.str.isdigit>`
Check whether all characters are digits.
:ref:`Series.str.isdecimal <pandas.Series.str.isdecimal>`
Check whether all characters are decimal.
:ref:`Series.str.isspace <pandas.Series.str.isspace>`
Check whether all characters are whitespace.
:ref:`Series.str.islower <pandas.Series.str.islower>`
Check whether all characters are lowercase.
:ref:`Series.str.isupper <pandas.Series.str.isupper>`
Check whether all characters are uppercase.
:ref:`Series.str.istitle <pandas.Series.str.istitle>`
Check whether all characters are titlecase.

Intel Scalable Dataframe Compiler Developer Guide
*************************************************

Pandas Series method :meth:`pandas.core.strings.StringMethods.isalnum()` implementation.

Note: Unicode type of list elements are supported only. Numpy.NaN is not supported as elements.

.. only:: developer

Test: python -m sdc.runtests sdc.tests.test_series.TestSeries.test_series_isalnum_str

Parameters
----------
self: :class:`pandas.core.strings.StringMethods`
input arg

Returns
-------
:obj:`pandas.Series`
returns :obj:`pandas.Series` object
"""

ty_checker = TypeChecker('Method isalnum().')
ty_checker.check(self, StringMethodsType)
Expand All @@ -1303,6 +1061,25 @@ def hpat_pandas_stringmethods_isalnum_impl(self):
return hpat_pandas_stringmethods_isalnum_impl


stringmethods_funcs = {
'istitle': {'method': hpat_pandas_stringmethods_istitle,
'caption': 'Check if each word start with an upper case letter'},
'isspace': {'method': hpat_pandas_stringmethods_isspace,
'caption': 'Check if all the characters in the text are whitespaces'},
'isalpha': {'method': hpat_pandas_stringmethods_isalpha,
'caption': 'Check whether all characters in each string are alphabetic'},
'islower': {'method': hpat_pandas_stringmethods_islower,
'caption': 'Check if all the characters in the text are alphanumeric'},
'isalnum': {'method': hpat_pandas_stringmethods_isalnum,
'caption': 'Check if all the characters in the text are alphanumeric'}
}


for name, data in stringmethods_funcs.items():
data['method'].__doc__ = sdc_pandas_series_str_docstring_template.format(**{'method_name': name,
'caption': data['caption']})


# _hpat_pandas_stringmethods_autogen_methods = sorted(dir(numba.types.misc.UnicodeType.__getattribute__.__qualname__))
_hpat_pandas_stringmethods_autogen_methods = ['upper', 'lower', 'lstrip', 'rstrip', 'strip']
"""
Expand Down