Skip to content
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.

Sign up for GitHub

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

Eradicate CRLF line endings #8

Merged
merged 3 commits into from
Sep 25, 2024
Merged

Eradicate CRLF line endings #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e00eeb4
Convert line endings from CRLF to LF
Aratz Sep 20, 2024
331357d
Check for CRLF line endings in CI
Aratz Sep 20, 2024
ffae8f6
Ignore case when looking for files
Aratz Sep 25, 2024
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
7 changes: 7 additions & 0 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---

name: Run Unit Tests

on: [push, pull_request]
Expand All @@ -9,6 +10,12 @@ jobs:

steps:
- uses: actions/checkout@v4
- name: Check for CRLF line endings
run: >
! find . -type f -iname "*.py"
| grep -v '\.git/'
| xargs file
| grep CRLF
- uses: actions/setup-python@v5
with:
python-version: "3.12"
Expand Down
322 changes: 161 additions & 161 deletions arteria/handlers/arteria_runfolder_handlers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,161 +1,161 @@
from aiohttp import web
from pathlib import Path
from arteria import __version__
import logging
from arteria.models.state import State
from arteria.models.config import Config
from arteria.handlers.base import base_routes
from arteria.models.runfolder_utils import Runfolder, list_runfolders
routes = base_routes
log = logging.getLogger(__name__)
@routes.post("/runfolders/path/{runfolder:.*}")
async def post_runfolders(request):
"""
When this is called with payload {"state": "STARTED"},
the state of the runfolder is set to STARTED
"""
data = await request.post()
runfolder_path = Path(request.match_info['runfolder'])
if not any([
runfolder_path.parent == Path(monitored_directory)
for monitored_directory in Config()['monitored_directories']
]):
raise web.HTTPBadRequest(
reason=f"{runfolder_path} does not belong to a monitored directory")
try:
runfolder = Runfolder(runfolder_path)
except AssertionError as exc:
log.exception(exc)
raise web.HTTPNotFound(reason=exc) from exc
state = data["state"]
try:
runfolder.state = State[state]
except KeyError as exc:
raise web.HTTPBadRequest(reason=f"The state '{state}' is not valid") from exc
return web.Response(status=200)
@routes.get("/runfolders/path/{runfolder:.*}")
async def get_runfolders(request):
"""
Returns some information about the runfolder as json
"""
runfolder_path = Path(request.match_info['runfolder'])
if not any([
runfolder_path.parent == Path(monitored_directory)
for monitored_directory in Config()['monitored_directories']
]):
raise web.HTTPBadRequest(
reason=f"{runfolder_path} does not belong to a monitored directory")
try:
runfolder = Runfolder(runfolder_path)
except AssertionError as exc:
log.exception(exc)
raise web.HTTPNotFound(reason=exc) from exc
return web.json_response(
data=serialize_runfolder_path(runfolder, request),
status=200
)
@routes.get("/runfolders/next")
async def get_next_runfolder(request):
"""
Finds unprocessed runfolder (state=ready) and then
returns some information about this runfolder.
"""
runfolders = list_runfolders(
Config()['monitored_directories'],
filter_key=lambda r: r.state == State.READY
)
if len(runfolders) > 0:
runfolder_dict = serialize_runfolder_path(runfolders[0], request)
return web.json_response(
data=runfolder_dict,
status=200
)
else:
raise web.HTTPNoContent(
reason="No ready runfolder found."
)
@routes.get("/runfolders/pickup")
async def get_pickup_runfolder(request):
"""
Used to start processing runfolders and also sets the runfolder to PENDING state.
"""
runfolders = list_runfolders(
Config()['monitored_directories'],
filter_key=lambda r: r.state == State.READY
)
if runfolders:
runfolders[0].state = State.PENDING
runfolder_dict = serialize_runfolder_path(runfolders[0], request)
return web.json_response(
data=runfolder_dict,
status=200
)
else:
raise web.HTTPNoContent(
reason="No ready runfolders available."
)
@routes.get("/runfolders")
async def get_all_runfolders(request):
"""
Returns information about all the runfolders that
match the state specified (or all runfolders when state
is not specified)
"""
runfolders = list_runfolders(
Config()['monitored_directories'],
filter_key=lambda r: r.state == State.READY
)
runfolders = [
serialize_runfolder_path(runfolder, request)
for runfolder in runfolders
]
return web.json_response(
data={"runfolders": runfolders},
status=200
)
def get_host_link(request, runfolder_path, ):
host = request.url.raw_host
link = f"{request.scheme}://{host}/api/1.0/runfolders/path{runfolder_path}"
return host, link
def serialize_runfolder_path(runfolder_cls, request):
"""
Get the path uri as web.json_response gives an error when
self.path is of type Path
"""
runfolder_dict = runfolder_cls.to_dict()
runfolder_dict['service_version'] = __version__
runfolder_path = Path(runfolder_dict['path'])
runfolder_dict['path'] = runfolder_path.as_uri()
runfolder_dict['host'], runfolder_dict['link'] = get_host_link(request, runfolder_path)
return runfolder_dict
from aiohttp import web
from pathlib import Path
from arteria import __version__
import logging
from arteria.models.state import State
from arteria.models.config import Config
from arteria.handlers.base import base_routes
from arteria.models.runfolder_utils import Runfolder, list_runfolders


routes = base_routes
log = logging.getLogger(__name__)


@routes.post("/runfolders/path/{runfolder:.*}")
async def post_runfolders(request):
"""
When this is called with payload {"state": "STARTED"},
the state of the runfolder is set to STARTED
"""

data = await request.post()
runfolder_path = Path(request.match_info['runfolder'])

if not any([
runfolder_path.parent == Path(monitored_directory)
for monitored_directory in Config()['monitored_directories']
]):
raise web.HTTPBadRequest(
reason=f"{runfolder_path} does not belong to a monitored directory")

try:
runfolder = Runfolder(runfolder_path)
except AssertionError as exc:
log.exception(exc)
raise web.HTTPNotFound(reason=exc) from exc

state = data["state"]
try:
runfolder.state = State[state]
except KeyError as exc:
raise web.HTTPBadRequest(reason=f"The state '{state}' is not valid") from exc

return web.Response(status=200)


@routes.get("/runfolders/path/{runfolder:.*}")
async def get_runfolders(request):
"""
Returns some information about the runfolder as json
"""
runfolder_path = Path(request.match_info['runfolder'])

if not any([
runfolder_path.parent == Path(monitored_directory)
for monitored_directory in Config()['monitored_directories']
]):
raise web.HTTPBadRequest(
reason=f"{runfolder_path} does not belong to a monitored directory")

try:
runfolder = Runfolder(runfolder_path)
except AssertionError as exc:
log.exception(exc)
raise web.HTTPNotFound(reason=exc) from exc

return web.json_response(
data=serialize_runfolder_path(runfolder, request),
status=200
)


@routes.get("/runfolders/next")
async def get_next_runfolder(request):
"""
Finds unprocessed runfolder (state=ready) and then
returns some information about this runfolder.
"""
runfolders = list_runfolders(
Config()['monitored_directories'],
filter_key=lambda r: r.state == State.READY
)

if len(runfolders) > 0:
runfolder_dict = serialize_runfolder_path(runfolders[0], request)

return web.json_response(
data=runfolder_dict,
status=200
)
else:
raise web.HTTPNoContent(
reason="No ready runfolder found."
)


@routes.get("/runfolders/pickup")
async def get_pickup_runfolder(request):
"""
Used to start processing runfolders and also sets the runfolder to PENDING state.
"""
runfolders = list_runfolders(
Config()['monitored_directories'],
filter_key=lambda r: r.state == State.READY
)

if runfolders:
runfolders[0].state = State.PENDING
runfolder_dict = serialize_runfolder_path(runfolders[0], request)
return web.json_response(
data=runfolder_dict,
status=200
)
else:
raise web.HTTPNoContent(
reason="No ready runfolders available."
)


@routes.get("/runfolders")
async def get_all_runfolders(request):
"""
Returns information about all the runfolders that
match the state specified (or all runfolders when state
is not specified)
"""
runfolders = list_runfolders(
Config()['monitored_directories'],
filter_key=lambda r: r.state == State.READY
)

runfolders = [
serialize_runfolder_path(runfolder, request)
for runfolder in runfolders
]

return web.json_response(
data={"runfolders": runfolders},
status=200
)


def get_host_link(request, runfolder_path, ):
host = request.url.raw_host
link = f"{request.scheme}://{host}/api/1.0/runfolders/path{runfolder_path}"

return host, link


def serialize_runfolder_path(runfolder_cls, request):
"""
Get the path uri as web.json_response gives an error when
self.path is of type Path
"""
runfolder_dict = runfolder_cls.to_dict()
runfolder_dict['service_version'] = __version__
runfolder_path = Path(runfolder_dict['path'])
runfolder_dict['path'] = runfolder_path.as_uri()
runfolder_dict['host'], runfolder_dict['link'] = get_host_link(request, runfolder_path)

return runfolder_dict