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

Jump to bottom

Update Versioneer #1

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update Versioneer #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
79 changes: 51 additions & 28 deletions spopt/_version.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
# that just contains the computed version number.

# This file is released into the public domain.
# Generated by versioneer-0.28
# Generated by versioneer-0.29
# https://github.com/python-versioneer/python-versioneer

"""Git implementation of _version.py."""
Expand All @@ -15,11 +15,11 @@
import re
import subprocess
import sys
from typing import Callable, Dict
from typing import Any, Callable, Dict, List, Optional, Tuple
import functools


def get_keywords():
def get_keywords() -> Dict[str, str]:
"""Get the keywords needed to look up the version information."""
# these strings will be replaced by git during git-archive.
# setup.py/versioneer.py will grep for the variable names, so they must
Expand All @@ -35,8 +35,15 @@ def get_keywords():
class VersioneerConfig:
"""Container for Versioneer configuration parameters."""

VCS: str
style: str
tag_prefix: str
parentdir_prefix: str
versionfile_source: str
verbose: bool

def get_config():

def get_config() -> VersioneerConfig:
"""Create, populate and return the VersioneerConfig() object."""
# these strings are filled in when 'setup.py versioneer' creates
# _version.py
Expand All @@ -58,10 +65,10 @@ class NotThisMethod(Exception):
HANDLERS: Dict[str, Dict[str, Callable]] = {}


def register_vcs_handler(vcs, method): # decorator
def register_vcs_handler(vcs: str, method: str) -> Callable: # decorator
"""Create decorator to mark a method as the handler of a VCS."""

def decorate(f):
def decorate(f: Callable) -> Callable:
"""Store f in HANDLERS[vcs][method]."""
if vcs not in HANDLERS:
HANDLERS[vcs] = {}
Expand All @@ -71,12 +78,19 @@ def decorate(f):
return decorate


def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, env=None):
def run_command(
commands: List[str],
args: List[str],
cwd: Optional[str] = None,
verbose: bool = False,
hide_stderr: bool = False,
env: Optional[Dict[str, str]] = None,
) -> Tuple[Optional[str], Optional[int]]:
"""Call the given command(s)."""
assert isinstance(commands, list)
process = None

popen_kwargs = {}
popen_kwargs: Dict[str, Any] = {}
if sys.platform == "win32":
# This hides the console window if pythonw.exe is used
startupinfo = subprocess.STARTUPINFO()
Expand All @@ -96,8 +110,7 @@ def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, env=
**popen_kwargs,
)
break
except OSError:
e = sys.exc_info()[1]
except OSError as e:
if e.errno == errno.ENOENT:
continue
if verbose:
Expand All @@ -117,7 +130,11 @@ def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, env=
return stdout, process.returncode


def versions_from_parentdir(parentdir_prefix, root, verbose):
def versions_from_parentdir(
parentdir_prefix: str,
root: str,
verbose: bool,
) -> Dict[str, Any]:
"""Try to determine the version from the parent directory name.

Source tarballs conventionally unpack into a directory that includes both
Expand Down Expand Up @@ -148,13 +165,13 @@ def versions_from_parentdir(parentdir_prefix, root, verbose):


@register_vcs_handler("git", "get_keywords")
def git_get_keywords(versionfile_abs):
def git_get_keywords(versionfile_abs: str) -> Dict[str, str]:
"""Extract version information from the given file."""
# the code embedded in _version.py can just fetch the value of these
# keywords. When used from setup.py, we don't want to import _version.py,
# so we do it with a regexp instead. This function is not used from
# _version.py.
keywords = {}
keywords: Dict[str, str] = {}
try:
with open(versionfile_abs, "r") as fobj:
for line in fobj:
Expand All @@ -176,7 +193,11 @@ def git_get_keywords(versionfile_abs):


@register_vcs_handler("git", "keywords")
def git_versions_from_keywords(keywords, tag_prefix, verbose):
def git_versions_from_keywords(
keywords: Dict[str, str],
tag_prefix: str,
verbose: bool,
) -> Dict[str, Any]:
"""Get version information from git keywords."""
if "refnames" not in keywords:
raise NotThisMethod("Short version file found")
Expand Down Expand Up @@ -247,7 +268,9 @@ def git_versions_from_keywords(keywords, tag_prefix, verbose):


@register_vcs_handler("git", "pieces_from_vcs")
def git_pieces_from_vcs(tag_prefix, root, verbose, runner=run_command):
def git_pieces_from_vcs(
tag_prefix: str, root: str, verbose: bool, runner: Callable = run_command
) -> Dict[str, Any]:
"""Get version from 'git describe' in the root of the source tree.

This only gets called if the git-archive 'subst' keywords were *not*
Expand Down Expand Up @@ -295,7 +318,7 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, runner=run_command):
raise NotThisMethod("'git rev-parse' failed")
full_out = full_out.strip()

pieces = {}
pieces: Dict[str, Any] = {}
pieces["long"] = full_out
pieces["short"] = full_out[:7] # maybe improved later
pieces["error"] = None
Expand Down Expand Up @@ -387,14 +410,14 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, runner=run_command):
return pieces


def plus_or_dot(pieces):
def plus_or_dot(pieces: Dict[str, Any]) -> str:
"""Return a + if we don't already have one, else return a ."""
if "+" in pieces.get("closest-tag", ""):
return "."
return "+"


def render_pep440(pieces):
def render_pep440(pieces: Dict[str, Any]) -> str:
"""Build up version string, with post-release "local version identifier".

Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you
Expand All @@ -418,7 +441,7 @@ def render_pep440(pieces):
return rendered


def render_pep440_branch(pieces):
def render_pep440_branch(pieces: Dict[str, Any]) -> str:
"""TAG[[.dev0]+DISTANCE.gHEX[.dirty]] .

The ".dev0" means not master branch. Note that .dev0 sorts backwards
Expand Down Expand Up @@ -447,7 +470,7 @@ def render_pep440_branch(pieces):
return rendered


def pep440_split_post(ver):
def pep440_split_post(ver: str) -> Tuple[str, Optional[int]]:
"""Split pep440 version string at the post-release segment.

Returns the release segments before the post-release and the
Expand All @@ -457,7 +480,7 @@ def pep440_split_post(ver):
return vc[0], int(vc[1] or 0) if len(vc) == 2 else None


def render_pep440_pre(pieces):
def render_pep440_pre(pieces: Dict[str, Any]) -> str:
"""TAG[.postN.devDISTANCE] -- No -dirty.

Exceptions:
Expand All @@ -481,7 +504,7 @@ def render_pep440_pre(pieces):
return rendered


def render_pep440_post(pieces):
def render_pep440_post(pieces: Dict[str, Any]) -> str:
"""TAG[.postDISTANCE[.dev0]+gHEX] .

The ".dev0" means dirty. Note that .dev0 sorts backwards
Expand All @@ -508,7 +531,7 @@ def render_pep440_post(pieces):
return rendered


def render_pep440_post_branch(pieces):
def render_pep440_post_branch(pieces: Dict[str, Any]) -> str:
"""TAG[.postDISTANCE[.dev0]+gHEX[.dirty]] .

The ".dev0" means not master branch.
Expand Down Expand Up @@ -537,7 +560,7 @@ def render_pep440_post_branch(pieces):
return rendered


def render_pep440_old(pieces):
def render_pep440_old(pieces: Dict[str, Any]) -> str:
"""TAG[.postDISTANCE[.dev0]] .

The ".dev0" means dirty.
Expand All @@ -559,7 +582,7 @@ def render_pep440_old(pieces):
return rendered


def render_git_describe(pieces):
def render_git_describe(pieces: Dict[str, Any]) -> str:
"""TAG[-DISTANCE-gHEX][-dirty].

Like 'git describe --tags --dirty --always'.
Expand All @@ -579,7 +602,7 @@ def render_git_describe(pieces):
return rendered


def render_git_describe_long(pieces):
def render_git_describe_long(pieces: Dict[str, Any]) -> str:
"""TAG-DISTANCE-gHEX[-dirty].

Like 'git describe --tags --dirty --always -long'.
Expand All @@ -599,7 +622,7 @@ def render_git_describe_long(pieces):
return rendered


def render(pieces, style):
def render(pieces: Dict[str, Any], style: str) -> Dict[str, Any]:
"""Render the given version pieces into the requested style."""
if pieces["error"]:
return {
Expand Down Expand Up @@ -641,7 +664,7 @@ def render(pieces, style):
}


def get_versions():
def get_versions() -> Dict[str, Any]:
"""Get version information or return default if unable to do so."""
# I am in _version.py, which lives at ROOT/VERSIONFILE_SOURCE. If we have
# __file__, we can work backwards from there to the root. Some
Expand Down
27 changes: 15 additions & 12 deletions spopt/locate/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,11 @@
-3: "Undefined",
}


class SpecificationError(pulp.PulpError):
pass


class LocateSolver(BaseSpOptExactSolver):
"""Base class for the ``locate`` package."""

Expand Down Expand Up @@ -472,30 +474,31 @@ def add_predefined_facility_constraint(

"""
if predefined_fac.ndim == 2:
n,k = predefined_fac.shape
assert k == 1, "predefined facilties array must only be of shape (n_supply, 1) or (n_supply,)"
n, k = predefined_fac.shape
assert (
k == 1
), "predefined facilties array must only be of shape (n_supply, 1) or (n_supply,)"
predefined_fac = predefined_fac.squeeze()

n_predefined = len(predefined_fac)

if hasattr(obj, "fac_vars"):
fac_vars = getattr(obj, "fac_vars")

n_facilities = len(fac_vars)
if n_facilities < n_predefined: # treat as indices

if n_facilities < n_predefined: # treat as indices
dummies = numpy.zeros_like(fac_vars)
dummies[predefined_fac] = 1
elif n_facilities == n_predefined: # treat as dummies
elif n_facilities == n_predefined: # treat as dummies
dummies = predefined_fac.copy()
else:
raise ValueError(
"More preselected facilities were provided than supply sites. "
"Expected fewer preselected facilities than supply sites. Check"
" the shape of the predefined faciltiies & supply sites provided."
)


"More preselected facilities were provided than supply sites. "
"Expected fewer preselected facilities than supply sites. Check"
" the shape of the predefined faciltiies & supply sites provided."
)

for i, dummy in enumerate(dummies):
if dummy:
fac_vars[i].setInitialValue(1)
Expand Down
2 changes: 1 addition & 1 deletion spopt/locate/coverage.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
BackupPercentageMixinMixin,
LocateSolver,
FacilityModelBuilder,
SpecificationError
SpecificationError,
)
from scipy.spatial.distance import cdist

Expand Down
30 changes: 14 additions & 16 deletions spopt/locate/p_median.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
LocateSolver,
FacilityModelBuilder,
MeanDistanceMixin,
SpecificationError
SpecificationError,
)
from scipy.spatial.distance import cdist

Expand Down Expand Up @@ -254,21 +254,22 @@ def from_cost_matrix(
)
if facility_capacities is not None:
sorted_capacities = np.sort(facility_capacities)
highest_possible_capacity = sorted_capacities[-p_facilities:].sum()
if highest_possible_capacity < weights.sum():
raise SpecificationError(f"""
highest_possible_capacity = sorted_capacities[-p_facilities:].sum()
if highest_possible_capacity < weights.sum():
raise SpecificationError(
f"""
Problem is infeasible. The highest possible capacity
{highest_possible_capacity}, coming from the {p_facilities}
sites with the highest capacity, is smaller than the total demand {weights.sum()}.
"""
)
)
FacilityModelBuilder.add_facility_capacity_constraint(
p_median,
weights,
facility_capacities,
range(len(weights)),
range(len(facility_capacities))
)
range(len(facility_capacities)),
)
p_median.__add_obj(r_cli, r_fac)

FacilityModelBuilder.add_facility_constraint(p_median, p_facilities)
Expand Down Expand Up @@ -315,7 +316,7 @@ def from_geodataframe(
predefined_facility_col : str (default None)
Column name representing facilities are already defined.
facility_capacities_col: str (default None)
Column name representing the capacities of each facility.
Column name representing the capacities of each facility.
distance_metric : str (default 'euclidean')
A metric used for the distance calculations supported by
`scipy.spatial.distance.cdist <https://docs.scipy.org/doc/scipy/reference/generated/scipy.spatial.distance.cdist.html>`_.
Expand Down Expand Up @@ -436,15 +437,12 @@ def from_geodataframe(
distances = cdist(dem_data, fac_data, distance_metric)

return cls.from_cost_matrix(
cost_matrix=distances,
weights=service_load,
p_facilities=p_facilities,
predefined_facilities_arr = predefined_facilities_arr,
cost_matrix=distances,
weights=service_load,
p_facilities=p_facilities,
predefined_facilities_arr=predefined_facilities_arr,
facility_capcities=facility_capacities,
name=("capacitated" + name
if facility_capacities is not None
else name
)
name=("capacitated" + name if facility_capacities is not None else name),
)

def facility_client_array(self) -> None:
Expand Down
Loading