imports-logger 2.0.0__py2.py3-none-any.whl

imports_logger/__init__.py

@@ -0,0 +1,132 @@
+from __future__ import print_function
+
+# released under the MIT license https://opensource.org/licenses/MIT
+__VERSION__ = "2.0.0"
+
+
+def setup_logger(log_vsize=False):
+    print("===> installing imports_logger_override")
+    import os
+    import psutil
+
+    # import pdb
+    # import pprint
+    # import logging
+    import sys
+
+    from six.moves import builtins
+
+    # setup the memory vars
+    # the call is different on other versions of psutil.
+    # i've seen these 2, hopefully this will work in your case
+    _this_process = psutil.Process(os.getpid())
+    try:
+        _this_process.memory_info()
+        _f_memory = _this_process.memory_info
+    except:
+        _this_process.get_memory_info()
+        _f_memory = _this_process.get_memory_info
+    GET_MEMORY_R = lambda: _f_memory()[0]
+    GET_MEMORY_V = lambda: _f_memory()[1]
+
+    # set up the dirs
+    # we'll lot go `{CWD}/__imports_logger/runs/{VERSION}` in which `VERSION` is 001, 002, etc
+    REPORTS_DIR_BASE = os.path.join("__imports_logger", "runs")
+    if not os.path.exists(REPORTS_DIR_BASE):
+        os.makedirs(REPORTS_DIR_BASE)
+    dirs = [
+        i
+        for i in os.listdir(REPORTS_DIR_BASE)
+        if os.path.isdir(os.path.join(REPORTS_DIR_BASE, i))
+    ]
+    max_dirs = len(dirs)
+    REPORTS_DIR_RUN = os.path.join(REPORTS_DIR_BASE, "%03d" % max_dirs)
+    print("===-  Logging to `%s`" % REPORTS_DIR_RUN)
+    os.makedirs(REPORTS_DIR_RUN)
+    writer_success = open(os.path.join(REPORTS_DIR_RUN, "imports.txt"), "a")
+    writer_error = open(os.path.join(REPORTS_DIR_RUN, "errors.txt"), "a")
+
+    # we need this still
+    # PY3 -     __import__(name, globals=None, locals=None, fromlist=(), level=0) -> module
+    # PY2 -     __import__(name, globals={}, locals={}, fromlist=[], level=-1) -> module
+    realimport = builtins.__import__
+
+    # our override
+    def imports_logger_override(name, *args, **kwargs):
+        _mem_start = GET_MEMORY_R()
+        _mem_startv = GET_MEMORY_V()
+        _package_name = name
+        if len(args) == 4:
+            _package_name = "%s.%s" % (name, str(args[2]).replace(",", "|"))
+        # use sys._getframe, because the `inspect` module leaves a circular reference that won't clean up (even with an explicit delete)
+        _frame = sys._getframe(1)
+        try:
+            _caller_file = _frame.f_locals["__file__"]
+        except:
+            _caller_file = "<>"
+        try:
+            try:
+                _imported = realimport(name, *args, **kwargs)
+            except (ImportError, AttributeError) as exc:
+                raise ImportError(str(exc))
+            _mem_finish = GET_MEMORY_R()
+            _mem_growth = _mem_finish - _mem_start
+            if log_vsize:
+                _mem_finishv = GET_MEMORY_V()
+                _mem_growthv = _mem_finishv - _mem_startv
+                _line = "import|%s,%s,%s,%s,%s,%s,%s,%s\n" % (
+                    _package_name,
+                    _caller_file,
+                    _mem_growth,
+                    _mem_start,
+                    _mem_finish,
+                    _mem_growthv,
+                    _mem_startv,
+                    _mem_finishv,
+                )
+            else:
+                _line = "import|%s,%s,%s,%s,%s\n" % (
+                    _package_name,
+                    _caller_file,
+                    _mem_growth,
+                    _mem_start,
+                    _mem_finish,
+                )
+            writer_success.write(_line)
+            return _imported
+        except Exception as e:
+            _message = e.args[0]
+            if isinstance(e, ImportError) and _message.startswith("No module named"):
+                # print("ImportError: %s | via <%s> in <%s>" % (e, _package_name, _caller_file))
+                _mem_finish = GET_MEMORY_R()
+                _mem_growth = _mem_finish - _mem_start
+                if log_vsize:
+                    _mem_finishv = GET_MEMORY_V()
+                    _mem_growthv = _mem_finishv - _mem_startv
+                    _line = "import|%s,%s,%s,%s,%s,%s,%s,%s\n" % (
+                        _package_name,
+                        _caller_file,
+                        _mem_growth,
+                        _mem_start,
+                        _mem_finish,
+                        _mem_growthv,
+                        _mem_startv,
+                        _mem_finishv,
+                    )
+                else:
+                    _line = "import|%s,%s,%s,%s,%s\n" % (
+                        _package_name,
+                        _caller_file,
+                        _mem_growth,
+                        _mem_start,
+                        _mem_finish,
+                    )
+                writer_error.write(_line)
+            raise
+        finally:
+            del _caller_file
+            del _frame
+
+    # install the override
+    builtins.__import__ = imports_logger_override
+    print("<=== imports_logger_override installed")

imports_logger-2.0.0.dist-info/METADATA

@@ -0,0 +1,99 @@
+Metadata-Version: 2.4
+Name: imports_logger
+Version: 2.0.0
+Summary: Quick tool to log import statements
+Home-page: https://github.com/jvanasco/imports_logger
+Author: Jonathan Vanasco
+Author-email: jvanasco@2xlp.com
+License: MIT
+Keywords: import,logging,memory
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 3.5
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Requires-Python: !=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,>=2.7
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: psutil
+Requires-Dist: six
+Provides-Extra: testing
+Requires-Dist: pytest; extra == "testing"
+Requires-Dist: coverage; extra == "testing"
+Dynamic: license-file
+
+![Python package](https://github.com/jvanasco/imports_logger/workflows/Python%20package/badge.svg)
+
+Import Logger
+=============
+
+This was a terrible, quickly slapped together, package designed as a quick debugging tool.
+
+Over the past few years, it has proved to be incredibly useful.
+
+## what this does
+
+This package is used to override calls to `import`, wrapping every import with
+a call to `psutil` which measures memory.  
+
+The outputs are written to a versioned file as `csv` compatible text files --
+one for "successful" imports, another for "failures"".
+
+The output files are written to an `__imports_logged` directory and stored under
+an incremental `__imports_logged/runs` subfolder.
+
+This is rough and can be customized.  This should NEVER NEVER NEVER be used on
+production code.  This is a quick debugging tool.
+
+### DANGER DANGER DANGER
+
+DO NOT RUN THIS IN PRODUCTION
+
+### DANGER DANGER DANGER
+
+SERIOUSLY, DO NOT RUN THIS IN PRODUCTION
+
+Why not?  This library saves the loaded information in a versioned format - so
+every time you start/restart your applications, more disk space will be consumed.
+
+
+## so why would I use this?
+
+There are two main use-cases:
+
+1. The outputs can be processed and analyzed (even imported to Excel!) to
+   determine where the biggest imports are, and what causes them.
+
+2. Knowing import errors is useful in two situations: refactoring your own code,
+   and finding what libraries are conditionally importing other 3rd party tools.
+
+## requirements
+
+* `psutil`
+
+## usage
+
+try running the demo.py script
+
+it is just...
+
+	# at the top of your script
+    import imports_logger
+    imports_logger.setup_logger()
+
+	# your code here    
+	import re
+
+	# this should have created a folder named `__imports_logged/runs/001`
+
+the text in runs 001 should look like
+
+	import|re.None,demo.py,0,12664832,12664832

imports_logger-2.0.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+imports_logger/__init__.py,sha256=kDxKvIaUPOLWmrfkJNLhYbwcmtcl3PHJ8vqG0LVsLsg,4899
+imports_logger-2.0.0.dist-info/licenses/LICENSE.txt,sha256=HGwQg0OCAkR5EPZnIxnj4aFfG2Yen_jn6Dami5OiJOc,1083
+imports_logger-2.0.0.dist-info/METADATA,sha256=7277u6Xja1-_GpkVqOfcAJdvoCg12ZTG-goJIke3J28,3054
+imports_logger-2.0.0.dist-info/WHEEL,sha256=Uvlg2aNlEKdilsyFSJt1QX5me0eEbCjQzR3nZeFkvy4,109
+imports_logger-2.0.0.dist-info/top_level.txt,sha256=uwlADt14EuamFFm-BUe5VSxUjal_gOg1WIMSq4MiITw,15
+imports_logger-2.0.0.dist-info/RECORD,,

imports_logger-2.0.0.dist-info/WHEEL

@@ -0,0 +1,6 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py2-none-any
+Tag: py3-none-any
+

imports_logger-2.0.0.dist-info/licenses/LICENSE.txt

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+Copyright (c) 2016 Jonathan Vanasco
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

imports_logger-2.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+imports_logger