├── .gitignore ├── shell ├── format.sh ├── clean.sh └── lint.sh ├── ez_timer ├── __init__.py ├── timer_test.py ├── timer.py └── LICENSE ├── README.md ├── setup.py └── .github └── workflows └── actions.yml /.gitignore: -------------------------------------------------------------------------------- 1 | dist/ 2 | ez_timer.egg-info/ 3 | -------------------------------------------------------------------------------- /shell/format.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | isort --sl . 3 | black . 4 | 5 | -------------------------------------------------------------------------------- /ez_timer/__init__.py: -------------------------------------------------------------------------------- 1 | from ez_timer.timer import Timer 2 | 3 | ez_timer = Timer 4 | -------------------------------------------------------------------------------- /shell/clean.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | rm -rf ez_timer.egg-info/ 3 | rm -rf ez_timer/**/__pycache__ 4 | rm -rf ez_timer/__pycache__ 5 | rm -rf build/ 6 | -------------------------------------------------------------------------------- /ez_timer/timer_test.py: -------------------------------------------------------------------------------- 1 | import time 2 | import unittest 3 | 4 | from ez_timer import ez_timer 5 | 6 | 7 | class TestTimer(unittest.TestCase): 8 | def test_timer(self): 9 | with ez_timer() as timer: 10 | time.sleep(1.5) 11 | assert timer.result > 1 12 | -------------------------------------------------------------------------------- /ez_timer/timer.py: -------------------------------------------------------------------------------- 1 | import time 2 | 3 | 4 | class Timer: 5 | def __init__(self): 6 | self.start_time = None 7 | self.end_time = None 8 | 9 | def __enter__(self): 10 | self.start_time = time.perf_counter() 11 | return self 12 | 13 | def __exit__(self, exc_type, exc_value, exc_traceback): 14 | self.end_time = time.perf_counter() 15 | 16 | @property 17 | def result(self): 18 | if self.start_time is None or self.end_time is None: 19 | raise RuntimeError( 20 | "Attempting to use timer before timing context is exited." 21 | ) 22 | return self.end_time - self.start_time 23 | -------------------------------------------------------------------------------- /shell/lint.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | isort --sl -c . 3 | if ! [ $? -eq 0 ] 4 | then 5 | echo "Please run \"sh shell/format.sh\" to format the code." 6 | exit 1 7 | fi 8 | echo "no issues with isort" 9 | flake8 . 10 | if ! [ $? -eq 0 ] 11 | then 12 | echo "Please fix the code style issue." 13 | exit 1 14 | fi 15 | echo "no issues with flake8" 16 | black --check . 17 | if ! [ $? -eq 0 ] 18 | then 19 | echo "Please run \"sh shell/format.sh\" to format the code." 20 | exit 1 21 | fi 22 | echo "no issues with black" 23 | for i in $(find keras_cv -name '*.py') # or whatever other pattern... 24 | do 25 | if ! grep -q Copyright $i 26 | then 27 | echo "Copyright not found in $i" 28 | exit 1 29 | fi 30 | done 31 | echo "linting success!" 32 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ez-timer 2 | 3 | __The easiest way to time a code block in Python.__ 4 | 5 | Quick Links: 6 | - [Installation](#Installation) 7 | - [Usage](#Usage) 8 | - [Overview](#Overview) 9 | 10 | ## Overview 11 | `ez-timer` provides a single, easy to use API for timing function calls. 12 | 13 | ```python 14 | with ez_timer() as timer: 15 | 1 + 1 16 | timer.result 17 | # 0.000001 18 | ``` 19 | 20 | That is it. That is the API. Solves one problem, and solves it well. 21 | 22 | ### Background 23 | When working on extensive profiling for an enterprise Python project I regularly found myself writing: 24 | 25 | ```python 26 | start = time.time() 27 | # some code 28 | end = time.time() 29 | 30 | result = end - start 31 | # do something with result 32 | ``` 33 | 34 | While `timeit` exists, I found `timeit` to be heavy handed for what I needed. 35 | This inspired me to create `ez-timer`. 36 | 37 | ## Installation 38 | ez-timer can be installed from pypi: 39 | 40 | ```bash 41 | pip install ez-timer 42 | ``` 43 | 44 | ## Usage 45 | Using ez-timer is simple: 46 | 47 | ```python 48 | from ez_timer import ez_timer 49 | 50 | with ez_timer() as timer: 51 | # run expensive computation 52 | time.sleep(1) 53 | 54 | print(timer.result) 55 | # > 1.0001 56 | ``` 57 | 58 | That's all. That is the API. 59 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | # Copyright 2022 Luke Wood 2 | # 3 | # Licensed under the Apache License, Version 2.0 (the "License"); 4 | # you may not use this file except in compliance with the License. 5 | # You may obtain a copy of the License at 6 | # 7 | # https://www.apache.org/licenses/LICENSE-2.0 8 | # 9 | # Unless required by applicable law or agreed to in writing, software 10 | # distributed under the License is distributed on an "AS IS" BASIS, 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | # See the License for the specific language governing permissions and 13 | # limitations under the License. 14 | 15 | """Setup script.""" 16 | 17 | import pathlib 18 | 19 | from setuptools import find_packages 20 | from setuptools import setup 21 | 22 | # The directory containing this file 23 | HERE = pathlib.Path(__file__).parent 24 | 25 | # The text of the README file 26 | README = (HERE / "README.md").read_text() 27 | 28 | setup( 29 | name="ez-timer", 30 | description="The simplest way to time a block of code.", 31 | version="0.0.1", 32 | long_description=README, 33 | long_description_content_type="text/markdown", 34 | url="https://github.com/lukewood/ez-timer", 35 | author="Luke Wood", 36 | author_email="lukewoodcs@gmail.com", 37 | license="Apache License 2.0", 38 | install_requires=[], 39 | extras_require={ 40 | "tests": ["flake8", "isort", "black", "pytest"], 41 | }, 42 | classifiers=[ 43 | "Programming Language :: Python", 44 | "Programming Language :: Python :: 3.7", 45 | "Operating System :: Unix", 46 | "Operating System :: Microsoft :: Windows", 47 | "Operating System :: MacOS", 48 | "Topic :: Software Development", 49 | ], 50 | packages=find_packages(exclude=("*_test.py",)), 51 | ) 52 | -------------------------------------------------------------------------------- /.github/workflows/actions.yml: -------------------------------------------------------------------------------- 1 | name: Tests 2 | 3 | on: 4 | push: 5 | pull_request: 6 | release: 7 | types: [created] 8 | jobs: 9 | test: 10 | name: Test the code 11 | runs-on: ${{ matrix.os }} 12 | strategy: 13 | matrix: 14 | os: [windows-latest, ubuntu-latest] 15 | steps: 16 | - uses: actions/checkout@v2 17 | - name: Set up Python 3.7 18 | uses: actions/setup-python@v1 19 | with: 20 | python-version: 3.7 21 | - name: Get pip cache dir 22 | id: pip-cache 23 | run: | 24 | python -m pip install --upgrade pip setuptools 25 | echo "::set-output name=dir::$(pip cache dir)" 26 | - name: pip cache 27 | uses: actions/cache@v2 28 | with: 29 | path: ${{ steps.pip-cache.outputs.dir }} 30 | key: ${{ runner.os }}-pip-${{ hashFiles('setup.py') }} 31 | restore-keys: | 32 | ${{ runner.os }}-pip- 33 | - name: Install dependencies 34 | run: | 35 | pip install -e ".[tests]" --progress-bar off --upgrade 36 | - name: Test with pytest 37 | run: | 38 | pytest ez_timer/ 39 | format: 40 | name: Check the code format 41 | runs-on: ubuntu-latest 42 | steps: 43 | - uses: actions/checkout@v2 44 | - name: Set up Python 3.7 45 | uses: actions/setup-python@v1 46 | with: 47 | python-version: 3.7 48 | - name: Get pip cache dir 49 | id: pip-cache 50 | run: | 51 | python -m pip install --upgrade pip setuptools 52 | echo "::set-output name=dir::$(pip cache dir)" 53 | - name: pip cache 54 | uses: actions/cache@v2 55 | with: 56 | path: ${{ steps.pip-cache.outputs.dir }} 57 | key: ${{ runner.os }}-pip-${{ hashFiles('setup.py') }} 58 | restore-keys: | 59 | ${{ runner.os }}-pip- 60 | - name: Install dependencies 61 | run: | 62 | pip install tensorflow 63 | pip install -e ".[tests]" --progress-bar off --upgrade 64 | - name: Lint 65 | run: bash shell/lint.sh 66 | -------------------------------------------------------------------------------- /ez_timer/LICENSE: -------------------------------------------------------------------------------- 1 | Copyright 2022 Luke Wood. All rights reserved. 2 | 3 | Apache License 4 | Version 2.0, January 2004 5 | http://www.apache.org/licenses/ 6 | 7 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 8 | 9 | 1. Definitions. 10 | 11 | "License" shall mean the terms and conditions for use, reproduction, 12 | and distribution as defined by Sections 1 through 9 of this document. 13 | 14 | "Licensor" shall mean the copyright owner or entity authorized by 15 | the copyright owner that is granting the License. 16 | 17 | "Legal Entity" shall mean the union of the acting entity and all 18 | other entities that control, are controlled by, or are under common 19 | control with that entity. For the purposes of this definition, 20 | "control" means (i) the power, direct or indirect, to cause the 21 | direction or management of such entity, whether by contract or 22 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 23 | outstanding shares, or (iii) beneficial ownership of such entity. 24 | 25 | "You" (or "Your") shall mean an individual or Legal Entity 26 | exercising permissions granted by this License. 27 | 28 | "Source" form shall mean the preferred form for making modifications, 29 | including but not limited to software source code, documentation 30 | source, and configuration files. 31 | 32 | "Object" form shall mean any form resulting from mechanical 33 | transformation or translation of a Source form, including but 34 | not limited to compiled object code, generated documentation, 35 | and conversions to other media types. 36 | 37 | "Work" shall mean the work of authorship, whether in Source or 38 | Object form, made available under the License, as indicated by a 39 | copyright notice that is included in or attached to the work 40 | (an example is provided in the Appendix below). 41 | 42 | "Derivative Works" shall mean any work, whether in Source or Object 43 | form, that is based on (or derived from) the Work and for which the 44 | editorial revisions, annotations, elaborations, or other modifications 45 | represent, as a whole, an original work of authorship. For the purposes 46 | of this License, Derivative Works shall not include works that remain 47 | separable from, or merely link (or bind by name) to the interfaces of, 48 | the Work and Derivative Works thereof. 49 | 50 | "Contribution" shall mean any work of authorship, including 51 | the original version of the Work and any modifications or additions 52 | to that Work or Derivative Works thereof, that is intentionally 53 | submitted to Licensor for inclusion in the Work by the copyright owner 54 | or by an individual or Legal Entity authorized to submit on behalf of 55 | the copyright owner. For the purposes of this definition, "submitted" 56 | means any form of electronic, verbal, or written communication sent 57 | to the Licensor or its representatives, including but not limited to 58 | communication on electronic mailing lists, source code control systems, 59 | and issue tracking systems that are managed by, or on behalf of, the 60 | Licensor for the purpose of discussing and improving the Work, but 61 | excluding communication that is conspicuously marked or otherwise 62 | designated in writing by the copyright owner as "Not a Contribution." 63 | 64 | "Contributor" shall mean Licensor and any individual or Legal Entity 65 | on behalf of whom a Contribution has been received by Licensor and 66 | subsequently incorporated within the Work. 67 | 68 | 2. Grant of Copyright License. Subject to the terms and conditions of 69 | this License, each Contributor hereby grants to You a perpetual, 70 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 71 | copyright license to reproduce, prepare Derivative Works of, 72 | publicly display, publicly perform, sublicense, and distribute the 73 | Work and such Derivative Works in Source or Object form. 74 | 75 | 3. Grant of Patent License. Subject to the terms and conditions of 76 | this License, each Contributor hereby grants to You a perpetual, 77 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 78 | (except as stated in this section) patent license to make, have made, 79 | use, offer to sell, sell, import, and otherwise transfer the Work, 80 | where such license applies only to those patent claims licensable 81 | by such Contributor that are necessarily infringed by their 82 | Contribution(s) alone or by combination of their Contribution(s) 83 | with the Work to which such Contribution(s) was submitted. If You 84 | institute patent litigation against any entity (including a 85 | cross-claim or counterclaim in a lawsuit) alleging that the Work 86 | or a Contribution incorporated within the Work constitutes direct 87 | or contributory patent infringement, then any patent licenses 88 | granted to You under this License for that Work shall terminate 89 | as of the date such litigation is filed. 90 | 91 | 4. Redistribution. You may reproduce and distribute copies of the 92 | Work or Derivative Works thereof in any medium, with or without 93 | modifications, and in Source or Object form, provided that You 94 | meet the following conditions: 95 | 96 | (a) You must give any other recipients of the Work or 97 | Derivative Works a copy of this License; and 98 | 99 | (b) You must cause any modified files to carry prominent notices 100 | stating that You changed the files; and 101 | 102 | (c) You must retain, in the Source form of any Derivative Works 103 | that You distribute, all copyright, patent, trademark, and 104 | attribution notices from the Source form of the Work, 105 | excluding those notices that do not pertain to any part of 106 | the Derivative Works; and 107 | 108 | (d) If the Work includes a "NOTICE" text file as part of its 109 | distribution, then any Derivative Works that You distribute must 110 | include a readable copy of the attribution notices contained 111 | within such NOTICE file, excluding those notices that do not 112 | pertain to any part of the Derivative Works, in at least one 113 | of the following places: within a NOTICE text file distributed 114 | as part of the Derivative Works; within the Source form or 115 | documentation, if provided along with the Derivative Works; or, 116 | within a display generated by the Derivative Works, if and 117 | wherever such third-party notices normally appear. The contents 118 | of the NOTICE file are for informational purposes only and 119 | do not modify the License. You may add Your own attribution 120 | notices within Derivative Works that You distribute, alongside 121 | or as an addendum to the NOTICE text from the Work, provided 122 | that such additional attribution notices cannot be construed 123 | as modifying the License. 124 | 125 | You may add Your own copyright statement to Your modifications and 126 | may provide additional or different license terms and conditions 127 | for use, reproduction, or distribution of Your modifications, or 128 | for any such Derivative Works as a whole, provided Your use, 129 | reproduction, and distribution of the Work otherwise complies with 130 | the conditions stated in this License. 131 | 132 | 5. Submission of Contributions. Unless You explicitly state otherwise, 133 | any Contribution intentionally submitted for inclusion in the Work 134 | by You to the Licensor shall be under the terms and conditions of 135 | this License, without any additional terms or conditions. 136 | Notwithstanding the above, nothing herein shall supersede or modify 137 | the terms of any separate license agreement you may have executed 138 | with Licensor regarding such Contributions. 139 | 140 | 6. Trademarks. This License does not grant permission to use the trade 141 | names, trademarks, service marks, or product names of the Licensor, 142 | except as required for reasonable and customary use in describing the 143 | origin of the Work and reproducing the content of the NOTICE file. 144 | 145 | 7. Disclaimer of Warranty. Unless required by applicable law or 146 | agreed to in writing, Licensor provides the Work (and each 147 | Contributor provides its Contributions) on an "AS IS" BASIS, 148 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 149 | implied, including, without limitation, any warranties or conditions 150 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 151 | PARTICULAR PURPOSE. You are solely responsible for determining the 152 | appropriateness of using or redistributing the Work and assume any 153 | risks associated with Your exercise of permissions under this License. 154 | 155 | 8. Limitation of Liability. In no event and under no legal theory, 156 | whether in tort (including negligence), contract, or otherwise, 157 | unless required by applicable law (such as deliberate and grossly 158 | negligent acts) or agreed to in writing, shall any Contributor be 159 | liable to You for damages, including any direct, indirect, special, 160 | incidental, or consequential damages of any character arising as a 161 | result of this License or out of the use or inability to use the 162 | Work (including but not limited to damages for loss of goodwill, 163 | work stoppage, computer failure or malfunction, or any and all 164 | other commercial damages or losses), even if such Contributor 165 | has been advised of the possibility of such damages. 166 | 167 | 9. Accepting Warranty or Additional Liability. While redistributing 168 | the Work or Derivative Works thereof, You may choose to offer, 169 | and charge a fee for, acceptance of support, warranty, indemnity, 170 | or other liability obligations and/or rights consistent with this 171 | License. However, in accepting such obligations, You may act only 172 | on Your own behalf and on Your sole responsibility, not on behalf 173 | of any other Contributor, and only if You agree to indemnify, 174 | defend, and hold each Contributor harmless for any liability 175 | incurred by, or claims asserted against, such Contributor by reason 176 | of your accepting any such warranty or additional liability. 177 | 178 | END OF TERMS AND CONDITIONS 179 | 180 | APPENDIX: How to apply the Apache License to your work. 181 | 182 | To apply the Apache License to your work, attach the following 183 | boilerplate notice, with the fields enclosed by brackets "[]" 184 | replaced with your own identifying information. (Don't include 185 | the brackets!) The text should be enclosed in the appropriate 186 | comment syntax for the file format. We also recommend that a 187 | file or class name and description of purpose be included on the 188 | same "printed page" as the copyright notice for easier 189 | identification within third-party archives. 190 | 191 | Copyright 2015, The TensorFlow Authors. 192 | 193 | Licensed under the Apache License, Version 2.0 (the "License"); 194 | you may not use this file except in compliance with the License. 195 | You may obtain a copy of the License at 196 | 197 | http://www.apache.org/licenses/LICENSE-2.0 198 | 199 | Unless required by applicable law or agreed to in writing, software 200 | distributed under the License is distributed on an "AS IS" BASIS, 201 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 202 | See the License for the specific language governing permissions and 203 | limitations under the License. 204 | --------------------------------------------------------------------------------