Skip to content
This repository was archived by the owner on Jun 10, 2025. It is now read-only.

Convenience properties for when API is next available #150

Merged
merged 10 commits into from
Sep 25, 2022
Merged
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: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
.DS_Store
.idea/
.pytest_cache/
.vscode/
**/__pycache__/
*.py[cod]
dist/
Expand All @@ -11,4 +13,4 @@ eggs/
pip-log.txt
docs/_build/
Pipfile.lock
venv/
venv/
32 changes: 31 additions & 1 deletion overpass/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,10 @@
import json
import logging
import re
from datetime import datetime
from datetime import datetime, timezone
from io import StringIO
from math import ceil
from typing import Optional

import geojson
import requests
Expand Down Expand Up @@ -204,6 +206,34 @@ def slots_running(self) -> tuple:
"""
return self._api_status()["running_slots"]

@property
def slot_available_datetime(self) -> Optional[datetime]:
"""
:returns: None if a slot is available now (no wait needed) or a datetime representing when the next slot will become available
"""
if self.slots_available:
return None
return min(self.slots_running + self.slots_waiting)

@property
def slot_available_countdown(self) -> int:
"""
:returns: 0 if a slot is available now, or an int of seconds until the next slot is free
"""
try:
return max(
ceil(
(
self.slot_available_datetime -
datetime.now(timezone.utc)
).total_seconds()
),
0
)
except TypeError:
# Can't subtract from None, which means slot is available now
return 0

def search(self, feature_type, regex=False):
"""Search for something."""
raise NotImplementedError()
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,5 @@
"Topic :: Utilities",
],
install_requires=["requests>=2.3.0", "geojson>=1.0.9", "shapely>=1.6.4"],
extras_require={"test": ["pytest"]},
extras_require={"test": ["pytest", "requests-mock[fixture]"]},
)
Loading