Skip to content

Commit 1d8685a

Browse files
committed
Apply autoformatting
1 parent 001e228 commit 1d8685a

File tree

9 files changed

+76
-89
lines changed

9 files changed

+76
-89
lines changed

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,3 @@ var/
2323
*.egg-info/
2424
.installed.cfg
2525
*.egg
26-

nbresuse/__init__.py

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
import os
22

33
from tornado import ioloop
4-
from traitlets import Bool, Float, Int, Union, default
4+
from traitlets import Bool
5+
from traitlets import default
6+
from traitlets import Float
7+
from traitlets import Int
8+
from traitlets import Union
59
from traitlets.config import Configurable
610

711
from nbresuse.prometheus import PrometheusHandler
@@ -17,21 +21,21 @@ def _jupyter_server_extension_paths():
1721
"""
1822
Set up the server extension for collecting metrics
1923
"""
20-
return [{
21-
'module': 'nbresuse',
22-
}]
24+
return [{"module": "nbresuse"}]
2325

2426

2527
def _jupyter_nbextension_paths():
2628
"""
2729
Set up the notebook extension for displaying metrics
2830
"""
29-
return [{
30-
"section": "notebook",
31-
"dest": "nbresuse",
32-
"src": "static",
33-
"require": "nbresuse/main"
34-
}]
31+
return [
32+
{
33+
"section": "notebook",
34+
"dest": "nbresuse",
35+
"src": "static",
36+
"require": "nbresuse/main",
37+
}
38+
]
3539

3640

3741
class ResourceUseDisplay(Configurable):
@@ -49,7 +53,7 @@ class ResourceUseDisplay(Configurable):
4953
we will start warning the user when they use (128 - (128 * 0.1)) MB.
5054
5155
Set to 0 to disable warning.
52-
"""
56+
""",
5357
).tag(config=True)
5458

5559
mem_limit = Union(
@@ -62,18 +66,18 @@ class ResourceUseDisplay(Configurable):
6266
6367
Defaults to reading from the `MEM_LIMIT` environment variable. If
6468
set to 0, the max memory available is displayed.
65-
"""
69+
""",
6670
).tag(config=True)
6771

68-
@default('mem_limit')
72+
@default("mem_limit")
6973
def _mem_limit_default(self):
70-
return int(os.environ.get('MEM_LIMIT', 0))
74+
return int(os.environ.get("MEM_LIMIT", 0))
7175

7276
track_cpu_percent = Bool(
7377
default_value=False,
7478
help="""
7579
Set to True in order to enable reporting of CPU usage statistics.
76-
"""
80+
""",
7781
).tag(config=True)
7882

7983
cpu_warning_threshold = Float(
@@ -86,7 +90,7 @@ def _mem_limit_default(self):
8690
we will start warning the user when they use (150 - (150 * 0.1)) %.
8791
8892
Set to 0 to disable warning.
89-
"""
93+
""",
9094
).tag(config=True)
9195

9296
cpu_limit = Float(
@@ -98,19 +102,19 @@ def _mem_limit_default(self):
98102
99103
Defaults to reading from the `CPU_LIMIT` environment variable. If
100104
set to 0, the total CPU count available is displayed.
101-
"""
105+
""",
102106
).tag(config=True)
103107

104-
@default('cpu_limit')
108+
@default("cpu_limit")
105109
def _cpu_limit_default(self):
106-
return float(os.environ.get('CPU_LIMIT', 0))
110+
return float(os.environ.get("CPU_LIMIT", 0))
107111

108112

109113
def load_jupyter_server_extension(nbapp):
110114
"""
111115
Called during notebook start
112116
"""
113117
resuseconfig = ResourceUseDisplay(parent=nbapp)
114-
nbapp.web_app.settings['nbresuse_display_config'] = resuseconfig
118+
nbapp.web_app.settings["nbresuse_display_config"] = resuseconfig
115119
callback = ioloop.PeriodicCallback(PrometheusHandler(nbapp), 1000)
116120
callback.start()

nbresuse/etc/nbextension.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,3 @@
33
"nbresuse/main": true
44
}
55
}
6-

nbresuse/etc/serverextension.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,3 @@
55
}
66
}
77
}
8-

nbresuse/metrics.py

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,7 @@ def memory_metrics() -> MemoryMetrics:
2020
rss = sum([p.memory_info().rss for p in all_processes])
2121
virtual_memory = psutil.virtual_memory()
2222

23-
return MemoryMetrics(
24-
rss,
25-
virtual_memory.total
26-
)
23+
return MemoryMetrics(rss, virtual_memory.total)
2724

2825

2926
def cpu_metrics() -> CPUMetrics:
@@ -39,9 +36,7 @@ def get_cpu_percent(p):
3936
# about dead processes having no CPU usage
4037
except BaseException:
4138
return 0
39+
4240
cpu_percent = sum([get_cpu_percent(p) for p in all_processes])
4341

44-
return CPUMetrics(
45-
cpu_count * 100.0,
46-
cpu_percent
47-
)
42+
return CPUMetrics(cpu_count * 100.0, cpu_percent)

nbresuse/prometheus.py

Lines changed: 9 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2,43 +2,30 @@
22
from prometheus_client import Gauge
33
from tornado import gen
44

5-
from nbresuse.metrics import CPUMetrics, MemoryMetrics, cpu_metrics, memory_metrics
5+
from nbresuse.metrics import cpu_metrics
6+
from nbresuse.metrics import CPUMetrics
7+
from nbresuse.metrics import memory_metrics
8+
from nbresuse.metrics import MemoryMetrics
69

710
try:
811
# Traitlets >= 4.3.3
912
from traitlets import Callable
1013
except ImportError:
1114
from .utils import Callable
1215

13-
TOTAL_MEMORY_USAGE = Gauge(
14-
'total_memory_usage',
15-
'counter for total memory usage',
16-
[]
17-
)
16+
TOTAL_MEMORY_USAGE = Gauge("total_memory_usage", "counter for total memory usage", [])
1817

19-
MAX_MEMORY_USAGE = Gauge(
20-
'max_memory_usage',
21-
'counter for max memory usage',
22-
[]
23-
)
18+
MAX_MEMORY_USAGE = Gauge("max_memory_usage", "counter for max memory usage", [])
2419

25-
TOTAL_CPU_USAGE = Gauge(
26-
'total_cpu_usage',
27-
'counter for total cpu usage',
28-
[]
29-
)
20+
TOTAL_CPU_USAGE = Gauge("total_cpu_usage", "counter for total cpu usage", [])
3021

31-
MAX_CPU_USAGE = Gauge(
32-
'max_cpu_usage',
33-
'counter for max cpu usage',
34-
[]
35-
)
22+
MAX_CPU_USAGE = Gauge("max_cpu_usage", "counter for max cpu usage", [])
3623

3724

3825
class PrometheusHandler(Callable):
3926
def __init__(self, nbapp: NotebookApp):
4027
super().__init__()
41-
self.config = nbapp.web_app.settings['nbresuse_display_config']
28+
self.config = nbapp.web_app.settings["nbresuse_display_config"]
4229
self.session_manager = nbapp.session_manager
4330

4431
@gen.coroutine

nbresuse/tests/test_basic.py

Lines changed: 25 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,45 @@
1-
from mock import MagicMock, patch
1+
from mock import MagicMock
2+
from mock import patch
23

34

45
class TestBasic:
5-
'''Some basic tests, checking import, making sure APIs remain consistent, etc'''
6+
"""Some basic tests, checking import, making sure APIs remain consistent, etc"""
67

78
def test_import_serverextension(self):
8-
'''Check that serverextension hooks are available'''
9-
from nbresuse import _jupyter_server_extension_paths, \
10-
_jupyter_nbextension_paths, \
11-
load_jupyter_server_extension
12-
13-
assert _jupyter_server_extension_paths() == [{'module': 'nbresuse'}]
14-
assert _jupyter_nbextension_paths() == [{
15-
"section": "notebook",
16-
"dest": "nbresuse",
17-
"src": "static",
18-
"require": "nbresuse/main"
19-
}]
9+
"""Check that serverextension hooks are available"""
10+
from nbresuse import (
11+
_jupyter_server_extension_paths,
12+
_jupyter_nbextension_paths,
13+
load_jupyter_server_extension,
14+
)
15+
16+
assert _jupyter_server_extension_paths() == [{"module": "nbresuse"}]
17+
assert _jupyter_nbextension_paths() == [
18+
{
19+
"section": "notebook",
20+
"dest": "nbresuse",
21+
"src": "static",
22+
"require": "nbresuse/main",
23+
}
24+
]
2025

2126
# mock a notebook app
2227
nbapp_mock = MagicMock()
2328
nbapp_mock.web_app.settings = {}
2429

2530
# mock these out for unit test
26-
with patch('tornado.ioloop.PeriodicCallback') as periodic_callback_mock, \
27-
patch('nbresuse.ResourceUseDisplay') as resource_use_display_mock, \
28-
patch('nbresuse.PrometheusHandler') as prometheus_handler_mock:
31+
with patch("tornado.ioloop.PeriodicCallback") as periodic_callback_mock, patch(
32+
"nbresuse.ResourceUseDisplay"
33+
) as resource_use_display_mock, patch(
34+
"nbresuse.PrometheusHandler"
35+
) as prometheus_handler_mock:
2936

3037
# load up with mock
3138
load_jupyter_server_extension(nbapp_mock)
3239

3340
# assert that we installed the application in settings
3441
print(nbapp_mock.web_app.settings)
35-
assert 'nbresuse_display_config' in nbapp_mock.web_app.settings
42+
assert "nbresuse_display_config" in nbapp_mock.web_app.settings
3643

3744
# assert that we instantiated a periodic callback with the fake
3845
# prometheus

nbresuse/utils.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
from traitlets import TraitType
21
import six
2+
from traitlets import TraitType
33

44
# copy-pasted from the master of Traitlets source
55

@@ -11,7 +11,7 @@ class Callable(TraitType):
1111
Classes are callable, as are instances
1212
with a __call__() method."""
1313

14-
info_text = 'a callable'
14+
info_text = "a callable"
1515

1616
def validate(self, obj, value):
1717
if six.callable(value):

setup.py

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1+
import pathlib
12
from glob import glob
3+
24
import setuptools
3-
import pathlib
45

56
# The directory containing this file
67
HERE = pathlib.Path(__file__).parent
@@ -10,7 +11,7 @@
1011

1112
setuptools.setup(
1213
name="nbresuse",
13-
version='0.3.3',
14+
version="0.3.3",
1415
url="https://github.com/yuvipanda/nbresuse",
1516
author="Yuvi Panda",
1617
description="Simple Jupyter extension to show how much resources (RAM) your notebook is using",
@@ -20,24 +21,20 @@
2021
classifiers=[
2122
"License :: OSI Approved :: BSD License",
2223
"Programming Language :: Python :: 3",
23-
],
24-
packages=setuptools.find_packages(),
25-
install_requires=[
26-
'psutil>=5.6.0',
27-
'notebook>=5.6.0',
2824
],
25+
packages=setuptools.find_packages(),
26+
install_requires=["psutil>=5.6.0", "notebook>=5.6.0"],
2927
extras_require={
30-
'dev': ['autopep8',
31-
'pytest',
32-
'flake8',
33-
'pytest-cov>=2.6.1',
34-
'mock']
28+
"dev": ["autopep8", "pytest", "flake8", "pytest-cov>=2.6.1", "mock"]
3529
},
3630
data_files=[
37-
('share/jupyter/nbextensions/nbresuse', glob('nbresuse/static/*')),
38-
('etc/jupyter/jupyter_notebook_config.d', ['nbresuse/etc/serverextension.json']),
39-
('etc/jupyter/nbconfig/notebook.d', ['nbresuse/etc/nbextension.json'])
31+
("share/jupyter/nbextensions/nbresuse", glob("nbresuse/static/*")),
32+
(
33+
"etc/jupyter/jupyter_notebook_config.d",
34+
["nbresuse/etc/serverextension.json"],
35+
),
36+
("etc/jupyter/nbconfig/notebook.d", ["nbresuse/etc/nbextension.json"]),
4037
],
4138
zip_safe=False,
42-
include_package_data=True
39+
include_package_data=True,
4340
)

0 commit comments

Comments
 (0)