The FrameFixtures library defines a tiny domain-specific language that permits using compact expressions to create diverse, deterministic DataFrame fixtures with StaticFrame. The resulting ``Frame`` can be used for test, performance studies, or documentation examples, and can easily be converted to Pandas DataFrames or other representations available via StaticFrame.
Code: https://github.com/static-frame/frame-fixtures
Packages: https://pypi.org/project/frame-fixtures
Installation
-------------------------------
Install FrameFixtures via PIP::
pip install frame-fixtures [extras]
The ``[extras]`` configuration includes StaticFrame as a requirement. As StaticFrame uses FrameFixtures, installation without ``[extras]`` assumes the availability of StaticFrame::
pip install frame-fixtures
Examples
------------------------------
Import FrameFixtures with the following convention:
>>> import frame_fixtures as ff
Create a 4 by 8 ``Frame`` of string, Booleans, and floats.
>>> ff.parse('v(str,str,bool,float)|s(4,8)')
<Frame>
<Index> 0 1 2 3 4 5 6 7 <int64>
<Index>
0 zjZQ zaji True 1080.4 zDVQ zEdH True 647.9
1 zO5l zJnC False 2580.34 z5hI zB7E True 2755.18
2 zEdH zDdR False 700.42 zyT8 zwIp False -1259.28
3 zB7E zuVU True 3338.48 zS6w zDVQ False 3442.84
<int64> <<U4> <<U4> <bool> <float64> <<U4> <<U4> <bool> <float64>
The same ``Frame`` can be converted to Pandas:
>>> ff.parse('v(str,str,bool,float)|s(4,8)').to_pandas()
0 1 2 3 4 5 6 7
0 zjZQ zaji True 1080.40 zDVQ zEdH True 647.90
1 zO5l zJnC False 2580.34 z5hI zB7E True 2755.18
2 zEdH zDdR False 700.42 zyT8 zwIp False -1259.28
3 zB7E zuVU True 3338.48 zS6w zDVQ False 3442.84
Create a 4 by 4 ``Frame`` of Booleans with three-level index and columns.
>>> ff.parse('v(bool)|i(IH,(str,int,str))|c(IH,(str,int,str))|s(4,4)')
<Frame>
<IndexHierarchy> zZbu zZbu zZbu zZbu <<U4>
105269 105269 119909 119909 <int64>
zDVQ z5hI zyT8 zS6w <<U4>
<IndexHierarchy>
zZbu 105269 zDVQ False False True False
zZbu 105269 z5hI False False False False
zZbu 119909 zyT8 False False False True
zZbu 119909 zS6w True False True True
<<U4> <int64> <<U4> <bool> <bool> <bool> <bool>
The same ``Frame`` can be converted to Pandas:
>>> ff.parse('v(bool)|i(IH,(str,int,str))|c(IH,(str,int,str))|s(4,4)').to_pandas()
__index0__ zZbu
__index1__ 105269 119909
__index2__ zDVQ z5hI zyT8 zS6w
__index0__ __index1__ __index2__
zZbu 105269 zDVQ False False True False
z5hI False False False False
119909 zyT8 False False False True
zS6w True False True True
FrameFixtures support defining features unique to StaticFrame, such as specifying a grow-only ``FrameGO``, ``Index`` types within ``IndexHierarchy``, and usage of ``np.datetime64`` types other than nanoseconds. These specifications are not directly convertible to Pandas.
>>> ff.parse('f(Fg)|v(int,bool,str)|i((IY,ID),(dtY,dtD))|c(ISg,dts)|s(6,2)')
<FrameGO>
<IndexSecondGO> 1970-01-01T09:38:35 1970-01-01T01:00:48 <datetime64[s]>
<IndexHierarchy>
36685 2258-03-21 -88017 False
36685 2298-04-20 92867 False
5618 2501-10-08 84967 False
5618 2441-04-14 13448 False
93271 2234-04-07 175579 False
93271 2210-12-26 58768 False
<datetime64[Y]> <datetime64[D]> <int64> <bool>
What is New in FramFixtures
------------------------------
1.1.0
............
Now compatible with NumPy 2.0.
Grammar
------------------------------
Container Components
.............................
A FrameFixture is defined by specifying one or more container components using symbols such as ``s`` for shape and ``i`` for index. Container components (CCs) are given arguments using Python function call syntax, and multiple CCs are delimited with ``|``. The shape CC takes integers as arguments; all other CCs take Constructor Specifiers (CS) and/or Dtype Specifiers (DS) as arguments. So a 100 by 20 ``Frame`` with an index of ``str`` is specified as ``s(100,20)|i(I,str)``, where 100 and 20 define the row and column counts, and `I` is the CC and `str` is the DS. Component symbols, whether components are required, and the number of required arguments, is summarized below.
+-------+----------+---------+----------+----------------------------------+
|Symbol |Component |Required |Arguments |Signature |
+=======+==========+=========+==========+==================================+
|f |Frame |False |1 |(CS,) |
+-------+----------+---------+----------+----------------------------------+
|i |Index |False |2 |(CS, DS) or ((CS, ...), (DS, ...))|
+-------+----------+---------+----------+----------------------------------+
|c |Columns |False |2 |(CS, DS) or ((CS, ...), (DS, ...))|
+-------+----------+---------+----------+----------------------------------+
|v |Values |False |unbound |(DS, ...) |
+-------+----------+---------+----------+----------------------------------+
|s |Shape |True |2 |(int, int) |
+-------+----------+---------+----------+----------------------------------+
Constructor Specifiers
.............................
CSs are given to the ``f`` CC; the ``i`` and ``c`` CC take one or many CSs as their first argument.
+-------+---------------------------+
|Symbol |Class |
+=======+===========================+
|F |Frame |
+-------+---------------------------+
|Fg |FrameGO |
+-------+---------------------------+
|I |Index |
+-------+---------------------------+
|Ig |IndexGO |
+-------+---------------------------+
|IH |IndexHierarchy |
+-------+---------------------------+
|IHg |IndexHierarchyGO |
+-------+---------------------------+
|IACF |IndexAutoConstructorFactory|
+-------+---------------------------+
|IY |IndexYear |
+-------+---------------------------+
|IYg |IndexYearGO |
+-------+---------------------------+
|IM |IndexYearMonth |
+-------+---------------------------+
|IMg |IndexYearMonthGO |
+-------+---------------------------+
|IYM |IndexYearMonth |
+-------+---------------------------+
|IYMg |IndexYearMonthGO |
+-------+---------------------------+
|ID |IndexDate |
+-------+---------------------------+
|IDg |IndexDateGO |
+-------+---------------------------+
|Ih |IndexHour |
+-------+---------------------------+
|Ihg |IndexHourGO |
+-------+---------------------------+
|Im |IndexMinute |
+-------+---------------------------+
|Img |IndexMinuteGO |
+-------+---------------------------+
|Is |IndexSecond |
+-------+---------------------------+
|Isg |IndexSecondGO |
+-------+---------------------------+
|Ims |IndexMillisecond |
+-------+---------------------------+
|Imsg |IndexMillisecondGO |
+-------+---------------------------+
|Ius |IndexMicrosecond |
+-------+---------------------------+
|Iusg |IndexMicrosecondGO |
+-------+---------------------------+
|Ins |IndexNanosecond |
+-------+---------------------------+
|Insg |IndexNanosecondGO |
+-------+---------------------------+
Dtype Specifiers
.............................
DSs are given to the ``v`` CC, and are used repeatedly to fill all columns; the ``i`` and ``c`` CC take one or many DSs as their second argument.
+-----------+--------------------------+
|Symbol |Class |
+===========+==========================+
|dtY |dtype('<M8[Y]') |
+-----------+--------------------------+
|dtM |dtype('<M8[M]') |
+-----------+--------------------------+
|dtD |dtype('<M8[D]') |
+-----------+--------------------------+
|dth |dtype('<M8[h]') |
+-----------+--------------------------+
|dtm |dtype('<M8[m]') |
+-----------+--------------------------+
|dts |dtype('<M8[s]') |
+-----------+--------------------------+
|dtms |dtype('<M8[ms]') |
+-----------+--------------------------+
|dtus |dtype('<M8[us]') |
+-----------+--------------------------+
|dtns |dtype('<M8[ns]') |
+-----------+--------------------------+
|tdY |dtype('<m8[Y]') |
+-----------+--------------------------+
|tdM |dtype('<m8[M]') |
+-----------+--------------------------+
|tdD |dtype('<m8[D]') |
+-----------+--------------------------+
|tdh |dtype('<m8[h]') |
+-----------+--------------------------+
|tdm |dtype('<m8[m]') |
+-----------+--------------------------+
|tds |dtype('<m8[s]') |
+-----------+--------------------------+
|tdms |dtype('<m8[ms]') |
+-----------+--------------------------+
|tdus |dtype('<m8[us]') |
+-----------+--------------------------+
|tdns |dtype('<m8[ns]') |
+-----------+--------------------------+
|int |<class 'int'> |
+-----------+--------------------------+
|str |<class 'str'> |
+-----------+--------------------------+
|bytes |<class 'bytes'> |
+-----------+--------------------------+
|float |<class 'float'> |
+-----------+--------------------------+
|bool |<class 'bool'> |
+-----------+--------------------------+
|complex |<class 'complex'> |
+-----------+--------------------------+
|object |<class 'object'> |
+-----------+--------------------------+
|int8 |<class 'numpy.int8'> |
+-----------+--------------------------+
|int16 |<class 'numpy.int16'> |
+-----------+--------------------------+
|int32 |<class 'numpy.int32'> |
+-----------+--------------------------+
|int64 |<class 'numpy.int64'> |
+-----------+--------------------------+
|uint8 |<class 'numpy.uint8'> |
+-----------+--------------------------+
|uint16 |<class 'numpy.uint16'> |
+-----------+--------------------------+
|uint32 |<class 'numpy.uint32'> |
+-----------+--------------------------+
|uint64 |<class 'numpy.uint64'> |
+-----------+--------------------------+
|float16 |<class 'numpy.float16'> |
+-----------+--------------------------+
|float32 |<class 'numpy.float32'> |
+-----------+--------------------------+
|float64 |<class 'numpy.float64'> |
+-----------+--------------------------+
|complex64 |<class 'numpy.complex64'> |
+-----------+--------------------------+
|complex128 |<class 'numpy.complex128'>|
+-----------+--------------------------+
Raw data
{
"_id": null,
"home_page": "https://github.com/static-frame/frame-fixtures",
"name": "frame-fixtures",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "dataframe fixtures test staticframe pandas numpy",
"author": "Christopher Ariza",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/b0/8b/9386c795c436e2d95d187decd2e982ce70a1f3e876489335032eddd35051/frame-fixtures-1.1.0.tar.gz",
"platform": null,
"description": "The FrameFixtures library defines a tiny domain-specific language that permits using compact expressions to create diverse, deterministic DataFrame fixtures with StaticFrame. The resulting ``Frame`` can be used for test, performance studies, or documentation examples, and can easily be converted to Pandas DataFrames or other representations available via StaticFrame.\n\n\nCode: https://github.com/static-frame/frame-fixtures\n\nPackages: https://pypi.org/project/frame-fixtures\n\n\n\nInstallation\n-------------------------------\n\nInstall FrameFixtures via PIP::\n\n pip install frame-fixtures [extras]\n\n\nThe ``[extras]`` configuration includes StaticFrame as a requirement. As StaticFrame uses FrameFixtures, installation without ``[extras]`` assumes the availability of StaticFrame::\n\n pip install frame-fixtures\n\n\nExamples\n------------------------------\n\nImport FrameFixtures with the following convention:\n\n>>> import frame_fixtures as ff\n\n\nCreate a 4 by 8 ``Frame`` of string, Booleans, and floats.\n\n>>> ff.parse('v(str,str,bool,float)|s(4,8)')\n<Frame>\n<Index> 0 1 2 3 4 5 6 7 <int64>\n<Index>\n0 zjZQ zaji True 1080.4 zDVQ zEdH True 647.9\n1 zO5l zJnC False 2580.34 z5hI zB7E True 2755.18\n2 zEdH zDdR False 700.42 zyT8 zwIp False -1259.28\n3 zB7E zuVU True 3338.48 zS6w zDVQ False 3442.84\n<int64> <<U4> <<U4> <bool> <float64> <<U4> <<U4> <bool> <float64>\n\n\nThe same ``Frame`` can be converted to Pandas:\n\n>>> ff.parse('v(str,str,bool,float)|s(4,8)').to_pandas()\n 0 1 2 3 4 5 6 7\n0 zjZQ zaji True 1080.40 zDVQ zEdH True 647.90\n1 zO5l zJnC False 2580.34 z5hI zB7E True 2755.18\n2 zEdH zDdR False 700.42 zyT8 zwIp False -1259.28\n3 zB7E zuVU True 3338.48 zS6w zDVQ False 3442.84\n\n\nCreate a 4 by 4 ``Frame`` of Booleans with three-level index and columns.\n\n>>> ff.parse('v(bool)|i(IH,(str,int,str))|c(IH,(str,int,str))|s(4,4)')\n<Frame>\n<IndexHierarchy> zZbu zZbu zZbu zZbu <<U4>\n 105269 105269 119909 119909 <int64>\n zDVQ z5hI zyT8 zS6w <<U4>\n<IndexHierarchy>\nzZbu 105269 zDVQ False False True False\nzZbu 105269 z5hI False False False False\nzZbu 119909 zyT8 False False False True\nzZbu 119909 zS6w True False True True\n<<U4> <int64> <<U4> <bool> <bool> <bool> <bool>\n\n\nThe same ``Frame`` can be converted to Pandas:\n\n>>> ff.parse('v(bool)|i(IH,(str,int,str))|c(IH,(str,int,str))|s(4,4)').to_pandas()\n__index0__ zZbu\n__index1__ 105269 119909\n__index2__ zDVQ z5hI zyT8 zS6w\n__index0__ __index1__ __index2__\nzZbu 105269 zDVQ False False True False\n z5hI False False False False\n 119909 zyT8 False False False True\n zS6w True False True True\n\n\nFrameFixtures support defining features unique to StaticFrame, such as specifying a grow-only ``FrameGO``, ``Index`` types within ``IndexHierarchy``, and usage of ``np.datetime64`` types other than nanoseconds. These specifications are not directly convertible to Pandas.\n\n>>> ff.parse('f(Fg)|v(int,bool,str)|i((IY,ID),(dtY,dtD))|c(ISg,dts)|s(6,2)')\n<FrameGO>\n<IndexSecondGO> 1970-01-01T09:38:35 1970-01-01T01:00:48 <datetime64[s]>\n<IndexHierarchy>\n36685 2258-03-21 -88017 False\n36685 2298-04-20 92867 False\n5618 2501-10-08 84967 False\n5618 2441-04-14 13448 False\n93271 2234-04-07 175579 False\n93271 2210-12-26 58768 False\n<datetime64[Y]> <datetime64[D]> <int64> <bool>\n\n\n\nWhat is New in FramFixtures\n------------------------------\n\n1.1.0\n............\n\nNow compatible with NumPy 2.0.\n\n\nGrammar\n------------------------------\n\nContainer Components\n.............................\n\nA FrameFixture is defined by specifying one or more container components using symbols such as ``s`` for shape and ``i`` for index. Container components (CCs) are given arguments using Python function call syntax, and multiple CCs are delimited with ``|``. The shape CC takes integers as arguments; all other CCs take Constructor Specifiers (CS) and/or Dtype Specifiers (DS) as arguments. So a 100 by 20 ``Frame`` with an index of ``str`` is specified as ``s(100,20)|i(I,str)``, where 100 and 20 define the row and column counts, and `I` is the CC and `str` is the DS. Component symbols, whether components are required, and the number of required arguments, is summarized below.\n\n+-------+----------+---------+----------+----------------------------------+\n|Symbol |Component |Required |Arguments |Signature |\n+=======+==========+=========+==========+==================================+\n|f |Frame |False |1 |(CS,) |\n+-------+----------+---------+----------+----------------------------------+\n|i |Index |False |2 |(CS, DS) or ((CS, ...), (DS, ...))|\n+-------+----------+---------+----------+----------------------------------+\n|c |Columns |False |2 |(CS, DS) or ((CS, ...), (DS, ...))|\n+-------+----------+---------+----------+----------------------------------+\n|v |Values |False |unbound |(DS, ...) |\n+-------+----------+---------+----------+----------------------------------+\n|s |Shape |True |2 |(int, int) |\n+-------+----------+---------+----------+----------------------------------+\n\n\nConstructor Specifiers\n.............................\n\nCSs are given to the ``f`` CC; the ``i`` and ``c`` CC take one or many CSs as their first argument.\n\n+-------+---------------------------+\n|Symbol |Class |\n+=======+===========================+\n|F |Frame |\n+-------+---------------------------+\n|Fg |FrameGO |\n+-------+---------------------------+\n|I |Index |\n+-------+---------------------------+\n|Ig |IndexGO |\n+-------+---------------------------+\n|IH |IndexHierarchy |\n+-------+---------------------------+\n|IHg |IndexHierarchyGO |\n+-------+---------------------------+\n|IACF |IndexAutoConstructorFactory|\n+-------+---------------------------+\n|IY |IndexYear |\n+-------+---------------------------+\n|IYg |IndexYearGO |\n+-------+---------------------------+\n|IM |IndexYearMonth |\n+-------+---------------------------+\n|IMg |IndexYearMonthGO |\n+-------+---------------------------+\n|IYM |IndexYearMonth |\n+-------+---------------------------+\n|IYMg |IndexYearMonthGO |\n+-------+---------------------------+\n|ID |IndexDate |\n+-------+---------------------------+\n|IDg |IndexDateGO |\n+-------+---------------------------+\n|Ih |IndexHour |\n+-------+---------------------------+\n|Ihg |IndexHourGO |\n+-------+---------------------------+\n|Im |IndexMinute |\n+-------+---------------------------+\n|Img |IndexMinuteGO |\n+-------+---------------------------+\n|Is |IndexSecond |\n+-------+---------------------------+\n|Isg |IndexSecondGO |\n+-------+---------------------------+\n|Ims |IndexMillisecond |\n+-------+---------------------------+\n|Imsg |IndexMillisecondGO |\n+-------+---------------------------+\n|Ius |IndexMicrosecond |\n+-------+---------------------------+\n|Iusg |IndexMicrosecondGO |\n+-------+---------------------------+\n|Ins |IndexNanosecond |\n+-------+---------------------------+\n|Insg |IndexNanosecondGO |\n+-------+---------------------------+\n\n\nDtype Specifiers\n.............................\n\nDSs are given to the ``v`` CC, and are used repeatedly to fill all columns; the ``i`` and ``c`` CC take one or many DSs as their second argument.\n\n+-----------+--------------------------+\n|Symbol |Class |\n+===========+==========================+\n|dtY |dtype('<M8[Y]') |\n+-----------+--------------------------+\n|dtM |dtype('<M8[M]') |\n+-----------+--------------------------+\n|dtD |dtype('<M8[D]') |\n+-----------+--------------------------+\n|dth |dtype('<M8[h]') |\n+-----------+--------------------------+\n|dtm |dtype('<M8[m]') |\n+-----------+--------------------------+\n|dts |dtype('<M8[s]') |\n+-----------+--------------------------+\n|dtms |dtype('<M8[ms]') |\n+-----------+--------------------------+\n|dtus |dtype('<M8[us]') |\n+-----------+--------------------------+\n|dtns |dtype('<M8[ns]') |\n+-----------+--------------------------+\n|tdY |dtype('<m8[Y]') |\n+-----------+--------------------------+\n|tdM |dtype('<m8[M]') |\n+-----------+--------------------------+\n|tdD |dtype('<m8[D]') |\n+-----------+--------------------------+\n|tdh |dtype('<m8[h]') |\n+-----------+--------------------------+\n|tdm |dtype('<m8[m]') |\n+-----------+--------------------------+\n|tds |dtype('<m8[s]') |\n+-----------+--------------------------+\n|tdms |dtype('<m8[ms]') |\n+-----------+--------------------------+\n|tdus |dtype('<m8[us]') |\n+-----------+--------------------------+\n|tdns |dtype('<m8[ns]') |\n+-----------+--------------------------+\n|int |<class 'int'> |\n+-----------+--------------------------+\n|str |<class 'str'> |\n+-----------+--------------------------+\n|bytes |<class 'bytes'> |\n+-----------+--------------------------+\n|float |<class 'float'> |\n+-----------+--------------------------+\n|bool |<class 'bool'> |\n+-----------+--------------------------+\n|complex |<class 'complex'> |\n+-----------+--------------------------+\n|object |<class 'object'> |\n+-----------+--------------------------+\n|int8 |<class 'numpy.int8'> |\n+-----------+--------------------------+\n|int16 |<class 'numpy.int16'> |\n+-----------+--------------------------+\n|int32 |<class 'numpy.int32'> |\n+-----------+--------------------------+\n|int64 |<class 'numpy.int64'> |\n+-----------+--------------------------+\n|uint8 |<class 'numpy.uint8'> |\n+-----------+--------------------------+\n|uint16 |<class 'numpy.uint16'> |\n+-----------+--------------------------+\n|uint32 |<class 'numpy.uint32'> |\n+-----------+--------------------------+\n|uint64 |<class 'numpy.uint64'> |\n+-----------+--------------------------+\n|float16 |<class 'numpy.float16'> |\n+-----------+--------------------------+\n|float32 |<class 'numpy.float32'> |\n+-----------+--------------------------+\n|float64 |<class 'numpy.float64'> |\n+-----------+--------------------------+\n|complex64 |<class 'numpy.complex64'> |\n+-----------+--------------------------+\n|complex128 |<class 'numpy.complex128'>|\n+-----------+--------------------------+\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Use compact expressions to create diverse, deterministic DataFrame fixtures with StaticFrame",
"version": "1.1.0",
"project_urls": {
"Homepage": "https://github.com/static-frame/frame-fixtures"
},
"split_keywords": [
"dataframe",
"fixtures",
"test",
"staticframe",
"pandas",
"numpy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "91bce32a8a5fb455f60fb42dacf15440d0e67ecd82fdc474820167b12a35aba3",
"md5": "29e72527e653203824bbab076435b189",
"sha256": "6cade13d5058909e6b9608bf34d984b84f3c9801d144b0746a656e382512f958"
},
"downloads": -1,
"filename": "frame_fixtures-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "29e72527e653203824bbab076435b189",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 11749,
"upload_time": "2024-07-13T06:38:57",
"upload_time_iso_8601": "2024-07-13T06:38:57.273635Z",
"url": "https://files.pythonhosted.org/packages/91/bc/e32a8a5fb455f60fb42dacf15440d0e67ecd82fdc474820167b12a35aba3/frame_fixtures-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b08b9386c795c436e2d95d187decd2e982ce70a1f3e876489335032eddd35051",
"md5": "2cf6026b122faa1a8def17bd63fb1370",
"sha256": "37b511993dda6d310f35b3ce480084004b21afdb563e9626059530075878b004"
},
"downloads": -1,
"filename": "frame-fixtures-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "2cf6026b122faa1a8def17bd63fb1370",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 14825,
"upload_time": "2024-07-13T06:38:58",
"upload_time_iso_8601": "2024-07-13T06:38:58.705295Z",
"url": "https://files.pythonhosted.org/packages/b0/8b/9386c795c436e2d95d187decd2e982ce70a1f3e876489335032eddd35051/frame-fixtures-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-13 06:38:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "static-frame",
"github_project": "frame-fixtures",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "numpy",
"specs": [
[
">=",
"1.18.5"
]
]
}
],
"lcname": "frame-fixtures"
}
JSON
