mik-laj commented on a change in pull request #7650: URL: https://github.com/apache/airflow/pull/7650#discussion_r411290597
########## File path: scripts/perf/perf_kit/__init__.py ########## @@ -0,0 +1,119 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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. +"""" + +Perf-kit +======== + +Useful decorators and context managers used when testing the performance of various Airflow components. + +To use this package, you must add the parent directory to the ``PYTHONPATH`` environment variable. If the +repository root directory is ``/opt/airflow/``, then you need to run the following command: + +.. code-block:: bash + export PYTHONPATH=/opt/airflow/scripts/perf + +Content +======= +The following decorators and context managers are included. + +.. autofunction:: perf_kit.memory.trace_memory + +.. autofunction:: perf_kit.python.pyspy + +.. autofunction:: perf_kit.python.profiled + +.. autofunction:: perf_kit.repeat_and_time.timing + +.. autofunction:: perf_kit.repeat_and_time.repeat + +.. autofunction:: perf_kit.repeat_and_time.timeout + +.. autofunction:: perf_kit.sqlalchemy.trace_queries + +.. autofunction:: perf_kit.sqlalchemy.count_queries + +Documentation for each function is provided in the function docstrings. Each module also has an example in +the main section of the module. + +Examples +======== + +If you want to run an all example for ``perf_kit.sqlalchemy``, you can run the following command. + +.. code-block:: bash + python -m perf_kit.sqlalchemy Review comment: Thanks. I added your suggestion. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected]
