Coverage for python/lsst/daf/butler/core/location.py : 38%

Hot-keys on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
# This file is part of daf_butler. # # Developed for the LSST Data Management System. # This product includes software developed by the LSST Project # (http://www.lsst.org). # See the COPYRIGHT file at the top-level directory of this distribution # for details of code ownership. # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see <http://www.gnu.org/licenses/>.
"""Identifies a location in the `Datastore`. """
self._datastoreRoot = datastoreRoot self._uri = urllib.parse.urlparse(uri)
def uri(self): """URI corresponding to location. """ return self._uri.geturl()
def path(self): """Path corresponding to location.
This path includes the root of the `Datastore`. """ return os.path.join(self._datastoreRoot, self._uri.path.lstrip("/"))
def pathInStore(self): """Path corresponding to location relative to `Datastore` root. """ return self._uri.path.lstrip("/")
"""Update the file extension associated with this `Location`.
Parameters ---------- ext : `str` New extension. If an empty string is given any extension will be removed. If `None` is given there will be no change. """ if ext is None: return path, _ = os.path.splitext(self._uri.path)
# Ensure that we have a leading "." on file extension (and we do not # try to modify the empty string) if ext and not ext.startswith("."): ext = "." + ext
parts = list(self._uri) parts[2] = path + ext self._uri = urllib.parse.urlparse(urllib.parse.urlunparse(parts))
"""Factory for `Location` instances. """
"""Constructor
Parameters ---------- datastoreRoot : `str` Root location of the `Datastore` in the filesystem. """ self._datastoreRoot = datastoreRoot
"""Factory function to create a `Location` from a URI.
Parameters ---------- uri : `str` A valid Universal Resource Identifier.
Returns location : `Location` The equivalent `Location`. """ if uri is None or not isinstance(uri, str): raise ValueError("URI must be a string and not {}".format(uri)) return Location(self._datastoreRoot, uri)
"""Factory function to create a `Location` from a POSIX path.
Parameters ---------- path : `str` A standard POSIX path, relative to the `Datastore` root.
Returns location : `Location` The equivalent `Location`. """ uri = urllib.parse.urljoin("file://", path) return self.fromUri(uri) |