Add HTML formatting to pre-commit

[michplunkett]

Fixes issue

#239

Description of Changes

Added djLint to the pre-commit process and formatted files accordingly.

Tests and linting

• This branch is up-to-date with the develop branch.
• pytest passes on my local development environment.
• pre-commit passes on my local development environment.

pre-commit output:

(openoversight) xxxxxx@MacBook-Air-5 OpenOversight % make lint
pre-commit run --all-files
trim trailing whitespace.................................................Passed
check docstring is first.................................................Passed
check that executables have shebangs.....................................Passed
check json...............................................................Passed
check for case conflicts.................................................Passed
check toml...........................................(no files to check)Skipped
check for merge conflicts................................................Passed
check xml................................................................Passed
check yaml...............................................................Passed
fix end of files.........................................................Passed
check for broken symlinks............................(no files to check)Skipped
mixed line ending........................................................Passed
fix python encoding pragma...............................................Passed
pretty format json.......................................................Passed
fix requirements.txt.....................................................Passed
check blanket noqa.......................................................Passed
check for not-real mock methods..........................................Passed
check for eval().........................................................Passed
use logger.warning(......................................................Passed
Run isort to sort imports................................................Passed
Run pydocstyle...........................................................Passed
Do not use shebangs in non-executable files..............................Passed
flake8...................................................................Passed
black....................................................................Passed
djLint formatting........................................................Passed
(openoversight) xxxxxx@MacBook-Air-5 OpenOversight % 

[AetherUnbound]

What a neat find! Being able to lint the template files is a huge win. I have one question about some changed assertions, I'm curious if we could still preserve the check for content order.

[AetherUnbound]

The changes to these assertions maybe feel like we aren't testing what we previously were (since order no longer matters with the new tests). Is it possible to change the assertions so they test the same thing even if there is whitespace in between?

[michplunkett]

I'll give it a shot, yup! It's replicated in the next PR (the image filtering one), so I'll make sure to make whatever change I make on this PR on that one as well.

[AetherUnbound]

Awesome, thank you! I wonder if we could do something like combined = "".join([token.strip() for token in filter_list]), then maybe the assertion can remain the same?

[michplunkett]

That sounds much simpler than the regex solution I was thinking of trying. I'll give it a shot tomorrow and respond back here.

[michplunkett]

I tried your solution and my solution of filter_list = [token.replace(" ", "").replace("\n", "") for token in filter_list to no avail.

The problem was that between the <dd> elements you had a starting line break and A LOT of spaces. To address that, I created this function and created all of the filter_lists with it.

def normalize_tokens_for_comparison(html_str: str, split_str: str):
  """Remove new lines, leading, and closing spaces between <dd> elements in
  formatted HTML."""
  parsed_list = html_str.data.decode(ENCODING_UTF_8).split(split_str)[1:]
  parsed_list = [re.sub(r"<dd>\n\s+", "<dd>", token) for token in parsed_list]
  parsed_list = [re.sub(r"\n\s+</dd>", "</dd>", token) for token in parsed_list]
  return parsed_list

I've since added it to both branches.

[AetherUnbound]

Fantastic!