{"author":null,"author_email":"Tian Gao ","bugtrack_url":null,"classifiers":["Development Status :: 4 - Beta","Intended Audience :: Developers","License :: OSI Approved :: Apache Software License","Operating System :: OS Independent","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.13","Programming Language :: Python :: 3.9"],"description":"# objprint\n\n[![build](https://github.com/gaogaotiantian/objprint/workflows/build/badge.svg)](https://github.com/gaogaotiantian/objprint/actions?query=workflow%3Abuild) [![coverage](https://img.shields.io/codecov/c/github/gaogaotiantian/objprint)](https://codecov.io/gh/gaogaotiantian/objprint) [![pypi](https://img.shields.io/pypi/v/objprint.svg)](https://pypi.org/project/objprint/) [![support-version](https://img.shields.io/pypi/pyversions/objprint)](https://img.shields.io/pypi/pyversions/objprint) [![license](https://img.shields.io/github/license/gaogaotiantian/objprint)](https://github.com/gaogaotiantian/objprint/blob/master/LICENSE) [![commit](https://img.shields.io/github/last-commit/gaogaotiantian/objprint)](https://github.com/gaogaotiantian/objprint/commits/master)\n\nA library that can print Python objects in human readable format\n\n## Install\n```\npip install objprint\n```\n\n## Usage\n\n### op\n\nUse ```op()``` (or ```objprint()```) to print objects.\n\n```python\nfrom objprint import op\n\nclass Position:\n def __init__(self, x, y):\n self.x = x\n self.y = y\n\nclass Player:\n def __init__(self):\n self.name = \"Alice\"\n self.age = 18\n self.items = [\"axe\", \"armor\"]\n self.coins = {\"gold\": 1, \"silver\": 33, \"bronze\": 57}\n self.position = Position(3, 5)\n\nop(Player())\n```\n\n```\n\n>\n```\n\nYou can print multiple objects just like print, except ``op`` will print them in separate lines\n\n```python\nop([1, 2], {'a': 1})\n```\n\n```\n[1, 2]\n{'a': 1}\n```\n\n``op`` will return the same object it prints, so you can do something like this\n\n```python\na = MyObject()\n# print the args inline with minumum change\nfunction_using_object(op(a))\n# the difference is more significant with complex expressions\n# original: function_using_object(a.f() + a.g())\nfunction_using_object(op(a.f() + a.g()))\n```\n\nIt works on multiple objects as well, as it returns a tuple, you need to unpack it for functions\n\n```python\na = MyObject()\nfunction_using_object(*op(a.f(), a.g()))\n```\n\n### add_objprint\n\nIf you want to use ```print()``` to print your object, you can also use the class decorator\n```add_objprint``` to add ```__str__``` method for your class.\n\n```python\nfrom objprint import add_objprint\n\nclass Position:\n def __init__(self, x, y):\n self.x = x\n self.y = y\n\n@add_objprint\nclass Player:\n def __init__(self):\n self.name = \"Alice\"\n self.age = 18\n self.items = [\"axe\", \"armor\"]\n self.coins = {\"gold\": 1, \"silver\": 33, \"bronze\": 57}\n self.position = Position(3, 5)\n\n# This will print the same thing as above\nprint(Player())\n```\n\n### objstr\n\nIf you want the ``str`` representation of the object, instead of printing it on the screen,\nyou can use ``objstr`` function\n\n```python\nfrom objprint import objstr\n\ns = objstr(my_object)\n```\n\n### print more\n\nThere are some optional information you can print with [config](#config).\n\n#### \"Public\" Methods\n\nThere are no REAL public methods in python, here I simply meant you can print methods that do not start with ``__`` as there will be\na lot of default magic methods and you don't want that.\n\n```python\nclass Player:\n def attack(self, opponent):\n pass\n\nop(Player(), print_methods=True)\n```\n\n```\n\n```\n\nAs you can see, it will also print the method signature(without ``self`` argument).\n\n#### Line numbers\n\nYou can print execution info, including the function it's in, the file and the line number of the printing line.\nThis is helpful for you to locate where this object is printed.\n\n```python\ndef f():\n op(Player(), line_number=True)\nf()\n```\n\n```\nf (my_script.py:29)\n\n```\n\n### Argument names\n\nYou can print the expression of the argument with `arg_name`\n\n```python\nop(Player(), arg_name=True)\n```\n\n```\nPlayer():\n\n```\n\n### objjson\n\n``objprint`` supports print objects to json to make it easier to serialize an object.\n\n``objjson`` returns a jsonifiable object that can be dumped with ``json.dumps``\n\n```python\nfrom objprint import objjson\n\njson_obj = objjson(Player())\n\nprint(json.dumps(json_obj, indent=2))\n```\n\n```\n{\n \".type\": \"Player\",\n \"name\": \"Alice\",\n \"age\": 18,\n \"items\": [\n \"axe\",\n \"armor\"\n ],\n \"coins\": {\n \"gold\": 1,\n \"silver\": 33,\n \"bronze\": 57\n },\n \"position\": {\n \".type\": \"Position\",\n \"x\": 3,\n \"y\": 5\n }\n}\n```\n\nYou can use ``op`` to print in json format directly with ``format=\"json\"``. You can pass in argument for ```json.dumps```\n\n```python\nop(Player(), format=\"json\", indent=2)\n```\n\n``add_objprint`` also works with ``format=\"json``\"\n\n```python\n@add_objprint(format=\"json\", indent=2)\nclass Player:\n pass\n```\n\n### Enable/Disable the print\n\nYou can disable prints from all the ``op()`` calls globally with ``enable`` config.\n\n```python\nfrom objprint import op\n\nop.disable()\nop([1, 2, 3]) # This won't print anything\nop.enable() # This could fix it!\n```\n\nOr you can use it for ``op()`` functions individually with some conditions\n\n```python\nop(obj, enable=check_do_print())\n```\n\n### attribute selection\n\nYou can customize which attribute to print with name filters.\n\n``objprint`` will try to match the attribute name with ``attr_pattern`` regex. The default\n``attr_pattern`` is ``r\"(!_).*\"``, which means anything that does NOT start with an `_`.\n\nYou can customize ``attr_pattern`` to select the attributes you want to print:\n\n```python\n# This will print all the attributes that do not start with __\nop(Player(), attr_pattern=r\"(!__).*\")\n```\n\nYou can also use ``include`` and ``exclude`` to specify attributes to print with regular expression\nso ```objprint``` will only print out the attributes you are interested in.\n\n```python\nop(Player(), include=[\"name\"])\n```\n```\n\n```\n\n```python\nop(Player(), exclude=[\".*s\"])\n```\n\n```\n\n>\n```\n\nIf you specify both ``include`` and ``exclude``, it will do a inclusive check first, then filter out the attributes\nthat match exclusive check.\n\n```attr_pattern```, ```include``` and ```exclude``` arguments work on ```objprint```, ```objstr``` and ```@add_objprint```.\n\n### Register Custom Type Formatter\n\nYou can also customize how certain types of objects are displayed by registering a custom formatter function to transform an object of a specific type into a string. \n\nFor example, you can print all integers in hexadecimal format by registering the ```hex()``` function for the ```int``` data type, or registering a custom ```lambda``` function. \n\n```python\nfrom objprint import op\n\nop.register_formatter(int, hex)\nop.register_formatter(float, lambda x: f\"{round(x, 3)}\")\nop(10) # prints 0xa\nop(3.14159) # prints 3.142\n```\n\nAlternatively, you can also register a custom formatter function using a decorator:\n\n```python\n@op.register_formatter(str)\ndef custom_formatter(obj: str):\n return f\"custom_print: {obj}\"\n\nop(\"hi\") # prints custom_print: hi\n```\n\nDuring registration, ```objprint``` will examine the specified object type, and raise a ```TypeError``` if an invalid object type is provided.\n\nWhen you finish using the custom formatters, you can unregister them with ```unregister_formatter()```.\n\n```python\nop.unregister_formatter(int, float, str)\nop(10) # prints 10\nop(3.14159) # prints 3.14159\nop(\"hi\") # prints hi\n```\n\nOr you can unregister everything by passing no argument to it.\n\n```python\nop.unregister_formatter()\n```\n\nThe ```register_formatter()``` function also accepts an ```inherit``` argument (default ```True```) to dictate if the registered formatter should also apply to any derived classes of the object type.\n\n```python\nclass BaseClass:\n name = 'A'\n\nclass DerivedClass(BaseClass):\n name = 'B'\n```\n\nWith ```inherit=True```, derived class will share the same formatter registered under base class. \n\n```python\ndef base_formatter(obj: BaseClass) -> str:\n return f'Print {obj.name} with Base Class Formatter'\n\nop.register_formatter(BaseClass, base_formatter, inherit=True)\n\nop(DerivedClass())\n```\n\n```\nPrint B with Base Class Formatter\n```\n\nWith ```inherit=False```, derived class will use the default formatter provided by ```objprint```. \n\n```python\n@op.register_formatter(BaseClass, inherit=False)\ndef base_formatter(obj: BaseClass) -> str:\n return f'Print {obj.name} with Base Class Formatter'\n\nop(DerivedClass())\n```\n\n```\n\n```\n\nIf a derived class inherits from multiple base classes, each with a registered formatter, the chosen formatter adheres to the Method Resolution Order (MRO) of the derived class.\n\nTo check all the registered functions and their inheritance status, you can use the ```get_formatter()``` method. It returns a dictionary-like object that you can print for easy inspection.\n\n```python\nfmts = op.get_formatter()\nprint(fmts)\n```\n\n```\n{: FormatterInfo(formatter=, inherit=False)}\n```\n\nPlease note that registering a formatter function with ```op``` will affect the output of ```objprint``` and ```objstr``` methods in the same way.\n\n### config\n\n```objprint``` formats the output based on some configs\n\n* ``config_name(default_value)`` - this config's explanation\n* ``enable(True)`` - whether to print, it's like a switch\n* ``depth(100)`` - how deep ```objprint``` goes into nested data structures\n* ``indent(2)`` - the indentation\n* ``width(80)`` - the maximum width a data structure will be presented as a single line\n* ``elements(-1)`` - the maximum number of elements that will be displayed, ``-1`` means no restriction\n* ``color(True)`` - whether to use colored scheme\n* ``line_number(False)`` - whether to print the ``function (filename:line_number)`` before printing the object\n* ``arg_name(False)`` - whether to print the argument expression before the argument value\n* ``skip_recursion(True)`` - whether skip printing recursive data, which would cause infinite recursion without ``depth`` constraint\n* ``honor_existing(True)`` - whether to use the existing user defined ``__repr__`` or ``__str__`` method\n* ``attr_pattern(r\"(!_).*\")`` - the regex pattern for attribute selection\n* ``include([])`` - the list of attribute regex to do an inclusive filter\n* ``exclude([])`` - the list of attribute regex to do an exclusive filter\n\nYou can set the configs globally using ``config`` function\n\n```python\nfrom objprint import config\nconfig(indent=4)\n```\n\nOr if you don't want to mess up your name space\n\n```python\nfrom objprint import op\nop.config(indent=4)\n```\n\nOr you can do a one time config by passing the arguments into ``objprint`` function\n\n```python\nfrom objprint import op\n\nop(var, indent=4)\n```\n\n### install\n\nMaybe you don't want to import ``op`` in every single file that you want to use. You can\nuse ``install`` to make it globally accessible\n\n```python\nfrom objprint import op, install\n\n# Now you can use op() in any file\ninstall()\n\n# This is the same\nop.install()\n\n# You can specify a name for objprint()\ninstall(\"my_print\")\nmy_print(my_object)\n```\n\n## Bugs/Requests\n\nPlease send bug reports and feature requests through [github issue tracker](https://github.com/gaogaotiantian/objprint/issues).\n\n## License\n\nCopyright 2020-2023 Tian Gao.\n\nDistributed under the terms of the [Apache 2.0 license](https://github.com/gaogaotiantian/objprint/blob/master/LICENSE).\n","description_content_type":"text/markdown","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":null,"keywords":null,"license":"Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. \"License\" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. \"Licensor\" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. \"Legal Entity\" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, \"control\" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. \"You\" (or \"Your\") shall mean an individual or Legal Entity exercising permissions granted by this License. \"Source\" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. \"Object\" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. \"Work\" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). \"Derivative Works\" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. \"Contribution\" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, \"submitted\" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as \"Not a Contribution.\" \"Contributor\" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a \"NOTICE\" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets \"[]\" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same \"printed page\" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ","license_expression":null,"license_files":null,"maintainer":null,"maintainer_email":null,"name":"objprint","package_url":"https://pypi.org/project/objprint/","platform":null,"project_url":"https://pypi.org/project/objprint/","project_urls":{"Homepage":"https://github.com/gaogaotiantian/objprint"},"provides_extra":null,"release_url":"https://pypi.org/project/objprint/0.3.0/","requires_dist":null,"requires_python":">=3.9","summary":"A library that can print Python objects in human readable format","version":"0.3.0","yanked":false,"yanked_reason":null}

Package search

objprint

project_urls

Dependencies

All package metadata

Releases