Skip to content

Dev clean lint #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 15 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .flake8
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[flake8]
ignore = W503
max-line-length = 79
ignore = W503, E203
max-line-length = 120
# max-complexity = 18
select = B,C,E,F,W,T4,B9
33 changes: 19 additions & 14 deletions jira_agile_metrics/calculator.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
import logging


logger = logging.getLogger(__name__)

class Calculator(object):
"""Base class for calculators.
"""

class Calculator:
"""Base class for calculators."""

def __init__(self, query_manager, settings, results):
"""Initialise with a `QueryManager`, a dict of `settings`,
Expand Down Expand Up @@ -35,28 +36,32 @@ def write(self):
target directory.
"""


def run_calculators(calculators, query_manager, settings):
"""Run all calculators passed in, in the order listed.
Returns the aggregated results.
"""

results = {}
calculators = [C(query_manager, settings, results) for C in calculators]
calculators = [calculator(query_manager, settings, results) for calculator in calculators]

# Run all calculators first
for c in calculators:
logger.info("%s running...", c.__class__.__name__)
results[c.__class__] = c.run()
logger.info("%s completed\n", c.__class__.__name__)
for calculator in calculators:
logger.info("%s running...", calculator.__class__.__name__)
results[calculator.__class__] = calculator.run()
logger.info("%s completed\n", calculator.__class__.__name__)

# Write all files as a second pass
for c in calculators:
logger.info("Writing file for %s...", c.__class__.__name__)
for calculator in calculators:
logger.info("Writing file for %s...", calculator.__class__.__name__)
try:
c.write()
except Exception as e:
logger.exception("Writing file for %s failed with a fatal error. Attempting to run subsequent writers regardless.", c.__class__.__name__)
calculator.write()
except Exception:
logger.exception(
"Writing file for %s failed with a fatal error. Attempting to run subsequent writers regardless.",
calculator.__class__.__name__,
)
else:
logger.info("%s completed\n", c.__class__.__name__)
logger.info("%s completed\n", calculator.__class__.__name__)

return results
31 changes: 11 additions & 20 deletions jira_agile_metrics/calculator_test.py
Original file line number Diff line number Diff line change
@@ -1,46 +1,37 @@
from .calculator import (
Calculator,
run_calculators
)
from .calculator import Calculator, run_calculators


def test_run_calculator():

written = []

class Enabled(Calculator):

def run(self):
return "Enabled"

def write(self):
written.append("Enabled")

class Disabled(Calculator):

class Disabled(Calculator):
def run(self):
return "Disabled"

def write(self):
pass

class GetPreviousResult(Calculator):

def run(self):
return self.get_result(Enabled) + " " + self.settings['foo']
return self.get_result(Enabled) + " " + self.settings["foo"]

def write(self):
written.append(self.get_result())

calculators = [Enabled, Disabled, GetPreviousResult]
query_manager = object()
settings = {'foo': 'bar'}
settings = {"foo": "bar"}

results = run_calculators(calculators, query_manager, settings)

assert results == {
Enabled: "Enabled",
Disabled: "Disabled",
GetPreviousResult: "Enabled bar"
}
assert results == {Enabled: "Enabled", Disabled: "Disabled", GetPreviousResult: "Enabled bar"}

assert written == ["Enabled", "Enabled bar"]
46 changes: 25 additions & 21 deletions jira_agile_metrics/calculators/ageingwip.py
Original file line number Diff line number Diff line change
@@ -1,32 +1,33 @@
import logging

import matplotlib.pyplot as plt
import numpy as np
import pandas as pd
import matplotlib.pyplot as plt
import seaborn as sns

from ..calculator import Calculator
from ..utils import set_chart_style

from .cycletime import CycleTimeCalculator


logger = logging.getLogger(__name__)


class AgeingWIPChartCalculator(Calculator):
"""Draw an ageing WIP chart
"""
"""Draw an ageing WIP chart"""

def run(self, today=None):

# short circuit relatively expensive calculation if it won't be used
if not self.settings['ageing_wip_chart']:
if not self.settings["ageing_wip_chart"]:
return None

cycle_data = self.get_result(CycleTimeCalculator)
cycle_names = [s['name'] for s in self.settings['cycle']]
cycle_names = [s["name"] for s in self.settings["cycle"]]

committed_column = self.settings['committed_column']
done_column = self.settings['done_column']
last_active_column = cycle_names[cycle_names.index(done_column)-1]
committed_column = self.settings["committed_column"]
done_column = self.settings["done_column"]
last_active_column = cycle_names[cycle_names.index(done_column) - 1]

today = pd.Timestamp.now().date() if today is None else today # to allow testing

Expand All @@ -48,22 +49,25 @@ def extract_age(row):
return np.NaN
return (today - started.date()).days

ageing_wip_data['status'] = ageing_wip_data.apply(extract_status, axis=1)
ageing_wip_data['age'] = ageing_wip_data.apply(extract_age, axis=1)
ageing_wip_data["status"] = ageing_wip_data.apply(extract_status, axis=1)
ageing_wip_data["age"] = ageing_wip_data.apply(extract_age, axis=1)

# remove blank rows
ageing_wip_data.dropna(how='any', inplace=True, subset=['status', 'age'])
ageing_wip_data.dropna(how="any", inplace=True, subset=["status", "age"])

# reorder columns so we get key, summary, status, age, and then all the cycle stages
ageing_wip_data = pd.concat((
ageing_wip_data[['key', 'summary', 'status', 'age']],
ageing_wip_data.loc[:, committed_column:last_active_column]
), axis=1)
ageing_wip_data = pd.concat(
(
ageing_wip_data[["key", "summary", "status", "age"]],
ageing_wip_data.loc[:, committed_column:last_active_column],
),
axis=1,
)

return ageing_wip_data

def write(self):
output_file = self.settings['ageing_wip_chart']
output_file = self.settings["ageing_wip_chart"]
if not output_file:
logger.debug("No output file specified for ageing WIP chart")
return
Expand All @@ -76,10 +80,10 @@ def write(self):

fig, ax = plt.subplots()

if self.settings['ageing_wip_chart_title']:
ax.set_title(self.settings['ageing_wip_chart_title'])
if self.settings["ageing_wip_chart_title"]:
ax.set_title(self.settings["ageing_wip_chart_title"])

sns.swarmplot(x='status', y='age', order=chart_data.columns[4:], data=chart_data, ax=ax)
sns.swarmplot(x="status", y="age", order=chart_data.columns[4:], data=chart_data, ax=ax)

ax.set_xlabel("Status")
ax.set_ylabel("Age (days)")
Expand All @@ -93,5 +97,5 @@ def write(self):

# Write file
logger.info("Writing ageing WIP chart to %s", output_file)
fig.savefig(output_file, bbox_inches='tight', dpi=300)
fig.savefig(output_file, bbox_inches="tight", dpi=300)
plt.close(fig)
Loading