repository_name
stringlengths
5
67
func_path_in_repository
stringlengths
4
234
func_name
stringlengths
0
314
whole_func_string
stringlengths
52
3.87M
language
stringclasses
6 values
func_code_string
stringlengths
52
3.87M
func_code_tokens
listlengths
15
672k
func_documentation_string
stringlengths
1
47.2k
func_documentation_tokens
listlengths
1
3.92k
split_name
stringclasses
1 value
func_code_url
stringlengths
85
339
progrium/skypipe
skypipe/client.py
sp_msg
def sp_msg(cmd, pipe=None, data=None): """Produces skypipe protocol multipart message""" msg = [SP_HEADER, cmd] if pipe is not None: msg.append(pipe) if data is not None: msg.append(data) return msg
python
def sp_msg(cmd, pipe=None, data=None): """Produces skypipe protocol multipart message""" msg = [SP_HEADER, cmd] if pipe is not None: msg.append(pipe) if data is not None: msg.append(data) return msg
[ "def", "sp_msg", "(", "cmd", ",", "pipe", "=", "None", ",", "data", "=", "None", ")", ":", "msg", "=", "[", "SP_HEADER", ",", "cmd", "]", "if", "pipe", "is", "not", "None", ":", "msg", ".", "append", "(", "pipe", ")", "if", "data", "is", "not",...
Produces skypipe protocol multipart message
[ "Produces", "skypipe", "protocol", "multipart", "message" ]
train
https://github.com/progrium/skypipe/blob/6162610a1876282ff1cc8eeca6c8669b8f605482/skypipe/client.py#L42-L49
progrium/skypipe
skypipe/client.py
check_skypipe_endpoint
def check_skypipe_endpoint(endpoint, timeout=10): """Skypipe endpoint checker -- pings endpoint Returns True if endpoint replies with valid header, Returns False if endpoint replies with invalid header, Returns None if endpoint does not reply within timeout """ socket = ctx.socket(zmq.DEALER) ...
python
def check_skypipe_endpoint(endpoint, timeout=10): """Skypipe endpoint checker -- pings endpoint Returns True if endpoint replies with valid header, Returns False if endpoint replies with invalid header, Returns None if endpoint does not reply within timeout """ socket = ctx.socket(zmq.DEALER) ...
[ "def", "check_skypipe_endpoint", "(", "endpoint", ",", "timeout", "=", "10", ")", ":", "socket", "=", "ctx", ".", "socket", "(", "zmq", ".", "DEALER", ")", "socket", ".", "linger", "=", "0", "socket", ".", "connect", "(", "endpoint", ")", "socket", "."...
Skypipe endpoint checker -- pings endpoint Returns True if endpoint replies with valid header, Returns False if endpoint replies with invalid header, Returns None if endpoint does not reply within timeout
[ "Skypipe", "endpoint", "checker", "--", "pings", "endpoint" ]
train
https://github.com/progrium/skypipe/blob/6162610a1876282ff1cc8eeca6c8669b8f605482/skypipe/client.py#L51-L72
progrium/skypipe
skypipe/client.py
stream_skypipe_output
def stream_skypipe_output(endpoint, name=None): """Generator for reading skypipe data""" name = name or '' socket = ctx.socket(zmq.DEALER) socket.connect(endpoint) try: socket.send_multipart(sp_msg(SP_CMD_LISTEN, name)) while True: msg = socket.recv_multipart() ...
python
def stream_skypipe_output(endpoint, name=None): """Generator for reading skypipe data""" name = name or '' socket = ctx.socket(zmq.DEALER) socket.connect(endpoint) try: socket.send_multipart(sp_msg(SP_CMD_LISTEN, name)) while True: msg = socket.recv_multipart() ...
[ "def", "stream_skypipe_output", "(", "endpoint", ",", "name", "=", "None", ")", ":", "name", "=", "name", "or", "''", "socket", "=", "ctx", ".", "socket", "(", "zmq", ".", "DEALER", ")", "socket", ".", "connect", "(", "endpoint", ")", "try", ":", "so...
Generator for reading skypipe data
[ "Generator", "for", "reading", "skypipe", "data" ]
train
https://github.com/progrium/skypipe/blob/6162610a1876282ff1cc8eeca6c8669b8f605482/skypipe/client.py#L75-L94
progrium/skypipe
skypipe/client.py
parse_skypipe_data_stream
def parse_skypipe_data_stream(msg, for_pipe): """May return data from skypipe message or raises EOFError""" header = str(msg.pop(0)) command = str(msg.pop(0)) pipe_name = str(msg.pop(0)) data = str(msg.pop(0)) if header != SP_HEADER: return if pipe_name != for_pipe: return if command != ...
python
def parse_skypipe_data_stream(msg, for_pipe): """May return data from skypipe message or raises EOFError""" header = str(msg.pop(0)) command = str(msg.pop(0)) pipe_name = str(msg.pop(0)) data = str(msg.pop(0)) if header != SP_HEADER: return if pipe_name != for_pipe: return if command != ...
[ "def", "parse_skypipe_data_stream", "(", "msg", ",", "for_pipe", ")", ":", "header", "=", "str", "(", "msg", ".", "pop", "(", "0", ")", ")", "command", "=", "str", "(", "msg", ".", "pop", "(", "0", ")", ")", "pipe_name", "=", "str", "(", "msg", "...
May return data from skypipe message or raises EOFError
[ "May", "return", "data", "from", "skypipe", "message", "or", "raises", "EOFError" ]
train
https://github.com/progrium/skypipe/blob/6162610a1876282ff1cc8eeca6c8669b8f605482/skypipe/client.py#L96-L108
progrium/skypipe
skypipe/client.py
skypipe_input_stream
def skypipe_input_stream(endpoint, name=None): """Returns a context manager for streaming data into skypipe""" name = name or '' class context_manager(object): def __enter__(self): self.socket = ctx.socket(zmq.DEALER) self.socket.connect(endpoint) return self ...
python
def skypipe_input_stream(endpoint, name=None): """Returns a context manager for streaming data into skypipe""" name = name or '' class context_manager(object): def __enter__(self): self.socket = ctx.socket(zmq.DEALER) self.socket.connect(endpoint) return self ...
[ "def", "skypipe_input_stream", "(", "endpoint", ",", "name", "=", "None", ")", ":", "name", "=", "name", "or", "''", "class", "context_manager", "(", "object", ")", ":", "def", "__enter__", "(", "self", ")", ":", "self", ".", "socket", "=", "ctx", ".",...
Returns a context manager for streaming data into skypipe
[ "Returns", "a", "context", "manager", "for", "streaming", "data", "into", "skypipe" ]
train
https://github.com/progrium/skypipe/blob/6162610a1876282ff1cc8eeca6c8669b8f605482/skypipe/client.py#L110-L128
progrium/skypipe
skypipe/client.py
stream_stdin_lines
def stream_stdin_lines(): """Generator for unbuffered line reading from STDIN""" stdin = os.fdopen(sys.stdin.fileno(), 'r', 0) while True: line = stdin.readline() if line: yield line else: break
python
def stream_stdin_lines(): """Generator for unbuffered line reading from STDIN""" stdin = os.fdopen(sys.stdin.fileno(), 'r', 0) while True: line = stdin.readline() if line: yield line else: break
[ "def", "stream_stdin_lines", "(", ")", ":", "stdin", "=", "os", ".", "fdopen", "(", "sys", ".", "stdin", ".", "fileno", "(", ")", ",", "'r'", ",", "0", ")", "while", "True", ":", "line", "=", "stdin", ".", "readline", "(", ")", "if", "line", ":",...
Generator for unbuffered line reading from STDIN
[ "Generator", "for", "unbuffered", "line", "reading", "from", "STDIN" ]
train
https://github.com/progrium/skypipe/blob/6162610a1876282ff1cc8eeca6c8669b8f605482/skypipe/client.py#L130-L138
progrium/skypipe
skypipe/client.py
run
def run(endpoint, name=None): """Runs the skypipe client""" try: if os.isatty(0): # output mode for data in stream_skypipe_output(endpoint, name): sys.stdout.write(data) sys.stdout.flush() else: # input mode with sk...
python
def run(endpoint, name=None): """Runs the skypipe client""" try: if os.isatty(0): # output mode for data in stream_skypipe_output(endpoint, name): sys.stdout.write(data) sys.stdout.flush() else: # input mode with sk...
[ "def", "run", "(", "endpoint", ",", "name", "=", "None", ")", ":", "try", ":", "if", "os", ".", "isatty", "(", "0", ")", ":", "# output mode", "for", "data", "in", "stream_skypipe_output", "(", "endpoint", ",", "name", ")", ":", "sys", ".", "stdout",...
Runs the skypipe client
[ "Runs", "the", "skypipe", "client" ]
train
https://github.com/progrium/skypipe/blob/6162610a1876282ff1cc8eeca6c8669b8f605482/skypipe/client.py#L140-L156
thombashi/DateTimeRange
datetimerange/__init__.py
DateTimeRange.validate_time_inversion
def validate_time_inversion(self): """ Check time inversion of the time range. :raises ValueError: If |attr_start_datetime| is bigger than |attr_end_datetime|. :raises TypeError: Any one of |attr_start_datetime| and |attr_end_datetime|, or...
python
def validate_time_inversion(self): """ Check time inversion of the time range. :raises ValueError: If |attr_start_datetime| is bigger than |attr_end_datetime|. :raises TypeError: Any one of |attr_start_datetime| and |attr_end_datetime|, or...
[ "def", "validate_time_inversion", "(", "self", ")", ":", "if", "not", "self", ".", "is_set", "(", ")", ":", "# for python2/3 compatibility", "raise", "TypeError", "if", "self", ".", "start_datetime", ">", "self", ".", "end_datetime", ":", "raise", "ValueError", ...
Check time inversion of the time range. :raises ValueError: If |attr_start_datetime| is bigger than |attr_end_datetime|. :raises TypeError: Any one of |attr_start_datetime| and |attr_end_datetime|, or both is inappropriate datetime value. :Sample...
[ "Check", "time", "inversion", "of", "the", "time", "range", "." ]
train
https://github.com/thombashi/DateTimeRange/blob/542a3b69ec256d28cc5d5469fd68207c1b509c9c/datetimerange/__init__.py#L239-L274
thombashi/DateTimeRange
datetimerange/__init__.py
DateTimeRange.get_start_time_str
def get_start_time_str(self): """ :return: |attr_start_datetime| as |str| formatted with |attr_start_time_format|. Return |NaT| if the invalid value or the invalid format. :rtype: str :Sample Code: .. code:: python from da...
python
def get_start_time_str(self): """ :return: |attr_start_datetime| as |str| formatted with |attr_start_time_format|. Return |NaT| if the invalid value or the invalid format. :rtype: str :Sample Code: .. code:: python from da...
[ "def", "get_start_time_str", "(", "self", ")", ":", "try", ":", "return", "self", ".", "start_datetime", ".", "strftime", "(", "self", ".", "start_time_format", ")", "except", "AttributeError", ":", "return", "self", ".", "NOT_A_TIME_STR" ]
:return: |attr_start_datetime| as |str| formatted with |attr_start_time_format|. Return |NaT| if the invalid value or the invalid format. :rtype: str :Sample Code: .. code:: python from datetimerange import DateTimeRange t...
[ ":", "return", ":", "|attr_start_datetime|", "as", "|str|", "formatted", "with", "|attr_start_time_format|", ".", "Return", "|NaT|", "if", "the", "invalid", "value", "or", "the", "invalid", "format", ".", ":", "rtype", ":", "str" ]
train
https://github.com/thombashi/DateTimeRange/blob/542a3b69ec256d28cc5d5469fd68207c1b509c9c/datetimerange/__init__.py#L333-L359
thombashi/DateTimeRange
datetimerange/__init__.py
DateTimeRange.get_end_time_str
def get_end_time_str(self): """ :return: |attr_end_datetime| as a |str| formatted with |attr_end_time_format|. Return |NaT| if invalid datetime or format. :rtype: str :Sample Code: .. code:: python from datetimerange impor...
python
def get_end_time_str(self): """ :return: |attr_end_datetime| as a |str| formatted with |attr_end_time_format|. Return |NaT| if invalid datetime or format. :rtype: str :Sample Code: .. code:: python from datetimerange impor...
[ "def", "get_end_time_str", "(", "self", ")", ":", "try", ":", "return", "self", ".", "end_datetime", ".", "strftime", "(", "self", ".", "end_time_format", ")", "except", "AttributeError", ":", "return", "self", ".", "NOT_A_TIME_STR" ]
:return: |attr_end_datetime| as a |str| formatted with |attr_end_time_format|. Return |NaT| if invalid datetime or format. :rtype: str :Sample Code: .. code:: python from datetimerange import DateTimeRange time_range = Dat...
[ ":", "return", ":", "|attr_end_datetime|", "as", "a", "|str|", "formatted", "with", "|attr_end_time_format|", ".", "Return", "|NaT|", "if", "invalid", "datetime", "or", "format", ".", ":", "rtype", ":", "str" ]
train
https://github.com/thombashi/DateTimeRange/blob/542a3b69ec256d28cc5d5469fd68207c1b509c9c/datetimerange/__init__.py#L361-L387
thombashi/DateTimeRange
datetimerange/__init__.py
DateTimeRange.set_start_datetime
def set_start_datetime(self, value, timezone=None): """ Set the start time of the time range. :param value: |param_start_datetime| :type value: |datetime|/|str| :raises ValueError: If the value is invalid as a |datetime| value. :Sample Code: .. code:: python...
python
def set_start_datetime(self, value, timezone=None): """ Set the start time of the time range. :param value: |param_start_datetime| :type value: |datetime|/|str| :raises ValueError: If the value is invalid as a |datetime| value. :Sample Code: .. code:: python...
[ "def", "set_start_datetime", "(", "self", ",", "value", ",", "timezone", "=", "None", ")", ":", "if", "value", "is", "None", ":", "self", ".", "__start_datetime", "=", "None", "return", "try", ":", "self", ".", "__start_datetime", "=", "typepy", ".", "ty...
Set the start time of the time range. :param value: |param_start_datetime| :type value: |datetime|/|str| :raises ValueError: If the value is invalid as a |datetime| value. :Sample Code: .. code:: python from datetimerange import DateTimeRange ...
[ "Set", "the", "start", "time", "of", "the", "time", "range", "." ]
train
https://github.com/thombashi/DateTimeRange/blob/542a3b69ec256d28cc5d5469fd68207c1b509c9c/datetimerange/__init__.py#L408-L440
thombashi/DateTimeRange
datetimerange/__init__.py
DateTimeRange.set_end_datetime
def set_end_datetime(self, value, timezone=None): """ Set the end time of the time range. :param datetime.datetime/str value: |param_end_datetime| :raises ValueError: If the value is invalid as a |datetime| value. :Sample Code: .. code:: python from...
python
def set_end_datetime(self, value, timezone=None): """ Set the end time of the time range. :param datetime.datetime/str value: |param_end_datetime| :raises ValueError: If the value is invalid as a |datetime| value. :Sample Code: .. code:: python from...
[ "def", "set_end_datetime", "(", "self", ",", "value", ",", "timezone", "=", "None", ")", ":", "if", "value", "is", "None", ":", "self", ".", "__end_datetime", "=", "None", "return", "try", ":", "self", ".", "__end_datetime", "=", "typepy", ".", "type", ...
Set the end time of the time range. :param datetime.datetime/str value: |param_end_datetime| :raises ValueError: If the value is invalid as a |datetime| value. :Sample Code: .. code:: python from datetimerange import DateTimeRange time_range = DateT...
[ "Set", "the", "end", "time", "of", "the", "time", "range", "." ]
train
https://github.com/thombashi/DateTimeRange/blob/542a3b69ec256d28cc5d5469fd68207c1b509c9c/datetimerange/__init__.py#L442-L473
thombashi/DateTimeRange
datetimerange/__init__.py
DateTimeRange.set_time_range
def set_time_range(self, start, end): """ :param datetime.datetime/str start: |param_start_datetime| :param datetime.datetime/str end: |param_end_datetime| :Sample Code: .. code:: python from datetimerange import DateTimeRange time_range = Da...
python
def set_time_range(self, start, end): """ :param datetime.datetime/str start: |param_start_datetime| :param datetime.datetime/str end: |param_end_datetime| :Sample Code: .. code:: python from datetimerange import DateTimeRange time_range = Da...
[ "def", "set_time_range", "(", "self", ",", "start", ",", "end", ")", ":", "self", ".", "set_start_datetime", "(", "start", ")", "self", ".", "set_end_datetime", "(", "end", ")" ]
:param datetime.datetime/str start: |param_start_datetime| :param datetime.datetime/str end: |param_end_datetime| :Sample Code: .. code:: python from datetimerange import DateTimeRange time_range = DateTimeRange() print(time_range) ...
[ ":", "param", "datetime", ".", "datetime", "/", "str", "start", ":", "|param_start_datetime|", ":", "param", "datetime", ".", "datetime", "/", "str", "end", ":", "|param_end_datetime|" ]
train
https://github.com/thombashi/DateTimeRange/blob/542a3b69ec256d28cc5d5469fd68207c1b509c9c/datetimerange/__init__.py#L475-L496
thombashi/DateTimeRange
datetimerange/__init__.py
DateTimeRange.range
def range(self, step): """ Return an iterator object. :param step: Step of iteration. :type step: |timedelta|/dateutil.relativedelta.relativedelta :return: iterator :rtype: iterator :Sample Code: .. code:: python import datetime ...
python
def range(self, step): """ Return an iterator object. :param step: Step of iteration. :type step: |timedelta|/dateutil.relativedelta.relativedelta :return: iterator :rtype: iterator :Sample Code: .. code:: python import datetime ...
[ "def", "range", "(", "self", ",", "step", ")", ":", "if", "self", ".", "__compare_timedelta", "(", "step", ",", "0", ")", "==", "0", ":", "raise", "ValueError", "(", "\"step must be not zero\"", ")", "is_inversion", "=", "False", "try", ":", "self", ".",...
Return an iterator object. :param step: Step of iteration. :type step: |timedelta|/dateutil.relativedelta.relativedelta :return: iterator :rtype: iterator :Sample Code: .. code:: python import datetime from datetimerange import DateT...
[ "Return", "an", "iterator", "object", "." ]
train
https://github.com/thombashi/DateTimeRange/blob/542a3b69ec256d28cc5d5469fd68207c1b509c9c/datetimerange/__init__.py#L552-L598
thombashi/DateTimeRange
datetimerange/__init__.py
DateTimeRange.intersection
def intersection(self, x): """ Newly set a time range that overlaps the input and the current time range. :param DateTimeRange x: Value to compute intersection with the current time range. :Sample Code: .. code:: python from datetimerang...
python
def intersection(self, x): """ Newly set a time range that overlaps the input and the current time range. :param DateTimeRange x: Value to compute intersection with the current time range. :Sample Code: .. code:: python from datetimerang...
[ "def", "intersection", "(", "self", ",", "x", ")", ":", "self", ".", "validate_time_inversion", "(", ")", "x", ".", "validate_time_inversion", "(", ")", "if", "any", "(", "[", "x", ".", "start_datetime", "in", "self", ",", "self", ".", "start_datetime", ...
Newly set a time range that overlaps the input and the current time range. :param DateTimeRange x: Value to compute intersection with the current time range. :Sample Code: .. code:: python from datetimerange import DateTimeRange dtr0 = D...
[ "Newly", "set", "a", "time", "range", "that", "overlaps", "the", "input", "and", "the", "current", "time", "range", "." ]
train
https://github.com/thombashi/DateTimeRange/blob/542a3b69ec256d28cc5d5469fd68207c1b509c9c/datetimerange/__init__.py#L600-L636
thombashi/DateTimeRange
datetimerange/__init__.py
DateTimeRange.encompass
def encompass(self, x): """ Newly set a time range that encompasses the input and the current time range. :param DateTimeRange x: Value to compute encompass with the current time range. :Sample Code: .. code:: python from datetimerange i...
python
def encompass(self, x): """ Newly set a time range that encompasses the input and the current time range. :param DateTimeRange x: Value to compute encompass with the current time range. :Sample Code: .. code:: python from datetimerange i...
[ "def", "encompass", "(", "self", ",", "x", ")", ":", "self", ".", "validate_time_inversion", "(", ")", "x", ".", "validate_time_inversion", "(", ")", "return", "DateTimeRange", "(", "start_datetime", "=", "min", "(", "self", ".", "start_datetime", ",", "x", ...
Newly set a time range that encompasses the input and the current time range. :param DateTimeRange x: Value to compute encompass with the current time range. :Sample Code: .. code:: python from datetimerange import DateTimeRange dtr0 = D...
[ "Newly", "set", "a", "time", "range", "that", "encompasses", "the", "input", "and", "the", "current", "time", "range", "." ]
train
https://github.com/thombashi/DateTimeRange/blob/542a3b69ec256d28cc5d5469fd68207c1b509c9c/datetimerange/__init__.py#L638-L667
thombashi/DateTimeRange
datetimerange/__init__.py
DateTimeRange.truncate
def truncate(self, percentage): """ Truncate ``percentage`` / 2 [%] of whole time from first and last time. :param float percentage: Percentage of truncate. :Sample Code: .. code:: python from datetimerange import DateTimeRange time_range = ...
python
def truncate(self, percentage): """ Truncate ``percentage`` / 2 [%] of whole time from first and last time. :param float percentage: Percentage of truncate. :Sample Code: .. code:: python from datetimerange import DateTimeRange time_range = ...
[ "def", "truncate", "(", "self", ",", "percentage", ")", ":", "self", ".", "validate_time_inversion", "(", ")", "if", "percentage", "<", "0", ":", "raise", "ValueError", "(", "\"discard_percent must be greater or equal to zero: \"", "+", "str", "(", "percentage", "...
Truncate ``percentage`` / 2 [%] of whole time from first and last time. :param float percentage: Percentage of truncate. :Sample Code: .. code:: python from datetimerange import DateTimeRange time_range = DateTimeRange( "2015-03-22T10:00...
[ "Truncate", "percentage", "/", "2", "[", "%", "]", "of", "whole", "time", "from", "first", "and", "last", "time", "." ]
train
https://github.com/thombashi/DateTimeRange/blob/542a3b69ec256d28cc5d5469fd68207c1b509c9c/datetimerange/__init__.py#L669-L703
progrium/skypipe
skypipe/cloud.py
wait_for
def wait_for(text, finish=None, io=None): """Displays dots until returned event is set""" if finish: finish.set() time.sleep(0.1) # threads, sigh if not io: io = sys.stdout finish = threading.Event() io.write(text) def _wait(): while not finish.is_set(): ...
python
def wait_for(text, finish=None, io=None): """Displays dots until returned event is set""" if finish: finish.set() time.sleep(0.1) # threads, sigh if not io: io = sys.stdout finish = threading.Event() io.write(text) def _wait(): while not finish.is_set(): ...
[ "def", "wait_for", "(", "text", ",", "finish", "=", "None", ",", "io", "=", "None", ")", ":", "if", "finish", ":", "finish", ".", "set", "(", ")", "time", ".", "sleep", "(", "0.1", ")", "# threads, sigh", "if", "not", "io", ":", "io", "=", "sys",...
Displays dots until returned event is set
[ "Displays", "dots", "until", "returned", "event", "is", "set" ]
train
https://github.com/progrium/skypipe/blob/6162610a1876282ff1cc8eeca6c8669b8f605482/skypipe/cloud.py#L37-L53
progrium/skypipe
skypipe/cloud.py
lookup_endpoint
def lookup_endpoint(cli): """Looks up the application endpoint from dotcloud""" url = '/applications/{0}/environment'.format(APPNAME) environ = cli.user.get(url).item port = environ['DOTCLOUD_SATELLITE_ZMQ_PORT'] host = socket.gethostbyname(environ['DOTCLOUD_SATELLITE_ZMQ_HOST']) return "tcp://{...
python
def lookup_endpoint(cli): """Looks up the application endpoint from dotcloud""" url = '/applications/{0}/environment'.format(APPNAME) environ = cli.user.get(url).item port = environ['DOTCLOUD_SATELLITE_ZMQ_PORT'] host = socket.gethostbyname(environ['DOTCLOUD_SATELLITE_ZMQ_HOST']) return "tcp://{...
[ "def", "lookup_endpoint", "(", "cli", ")", ":", "url", "=", "'/applications/{0}/environment'", ".", "format", "(", "APPNAME", ")", "environ", "=", "cli", ".", "user", ".", "get", "(", "url", ")", ".", "item", "port", "=", "environ", "[", "'DOTCLOUD_SATELLI...
Looks up the application endpoint from dotcloud
[ "Looks", "up", "the", "application", "endpoint", "from", "dotcloud" ]
train
https://github.com/progrium/skypipe/blob/6162610a1876282ff1cc8eeca6c8669b8f605482/skypipe/cloud.py#L56-L62
progrium/skypipe
skypipe/cloud.py
setup_dotcloud_account
def setup_dotcloud_account(cli): """Gets user/pass for dotcloud, performs auth, and stores keys""" client = RESTClient(endpoint=cli.client.endpoint) client.authenticator = NullAuth() urlmap = client.get('/auth/discovery').item username = cli.prompt('dotCloud email') password = cli.prompt('Passwo...
python
def setup_dotcloud_account(cli): """Gets user/pass for dotcloud, performs auth, and stores keys""" client = RESTClient(endpoint=cli.client.endpoint) client.authenticator = NullAuth() urlmap = client.get('/auth/discovery').item username = cli.prompt('dotCloud email') password = cli.prompt('Passwo...
[ "def", "setup_dotcloud_account", "(", "cli", ")", ":", "client", "=", "RESTClient", "(", "endpoint", "=", "cli", ".", "client", ".", "endpoint", ")", "client", ".", "authenticator", "=", "NullAuth", "(", ")", "urlmap", "=", "client", ".", "get", "(", "'/...
Gets user/pass for dotcloud, performs auth, and stores keys
[ "Gets", "user", "/", "pass", "for", "dotcloud", "performs", "auth", "and", "stores", "keys" ]
train
https://github.com/progrium/skypipe/blob/6162610a1876282ff1cc8eeca6c8669b8f605482/skypipe/cloud.py#L65-L84
progrium/skypipe
skypipe/cloud.py
setup
def setup(cli): """Everything to make skypipe ready to use""" if not cli.global_config.loaded: setup_dotcloud_account(cli) discover_satellite(cli) cli.success("Skypipe is ready for action")
python
def setup(cli): """Everything to make skypipe ready to use""" if not cli.global_config.loaded: setup_dotcloud_account(cli) discover_satellite(cli) cli.success("Skypipe is ready for action")
[ "def", "setup", "(", "cli", ")", ":", "if", "not", "cli", ".", "global_config", ".", "loaded", ":", "setup_dotcloud_account", "(", "cli", ")", "discover_satellite", "(", "cli", ")", "cli", ".", "success", "(", "\"Skypipe is ready for action\"", ")" ]
Everything to make skypipe ready to use
[ "Everything", "to", "make", "skypipe", "ready", "to", "use" ]
train
https://github.com/progrium/skypipe/blob/6162610a1876282ff1cc8eeca6c8669b8f605482/skypipe/cloud.py#L86-L91
progrium/skypipe
skypipe/cloud.py
discover_satellite
def discover_satellite(cli, deploy=True, timeout=5): """Looks to make sure a satellite exists, returns endpoint First makes sure we have dotcloud account credentials. Then it looks up the environment for the satellite app. This will contain host and port to construct an endpoint. However, if app doesn'...
python
def discover_satellite(cli, deploy=True, timeout=5): """Looks to make sure a satellite exists, returns endpoint First makes sure we have dotcloud account credentials. Then it looks up the environment for the satellite app. This will contain host and port to construct an endpoint. However, if app doesn'...
[ "def", "discover_satellite", "(", "cli", ",", "deploy", "=", "True", ",", "timeout", "=", "5", ")", ":", "if", "not", "cli", ".", "global_config", ".", "loaded", ":", "cli", ".", "die", "(", "\"Please setup skypipe by running `skypipe --setup`\"", ")", "try", ...
Looks to make sure a satellite exists, returns endpoint First makes sure we have dotcloud account credentials. Then it looks up the environment for the satellite app. This will contain host and port to construct an endpoint. However, if app doesn't exist, or endpoint does not check out, we call `launch...
[ "Looks", "to", "make", "sure", "a", "satellite", "exists", "returns", "endpoint" ]
train
https://github.com/progrium/skypipe/blob/6162610a1876282ff1cc8eeca6c8669b8f605482/skypipe/cloud.py#L94-L116
progrium/skypipe
skypipe/cloud.py
launch_satellite
def launch_satellite(cli): """Deploys a new satellite app over any existing app""" cli.info("Launching skypipe satellite:") finish = wait_for(" Pushing to dotCloud") # destroy any existing satellite destroy_satellite(cli) # create new satellite app url = '/applications' try: ...
python
def launch_satellite(cli): """Deploys a new satellite app over any existing app""" cli.info("Launching skypipe satellite:") finish = wait_for(" Pushing to dotCloud") # destroy any existing satellite destroy_satellite(cli) # create new satellite app url = '/applications' try: ...
[ "def", "launch_satellite", "(", "cli", ")", ":", "cli", ".", "info", "(", "\"Launching skypipe satellite:\"", ")", "finish", "=", "wait_for", "(", "\" Pushing to dotCloud\"", ")", "# destroy any existing satellite", "destroy_satellite", "(", "cli", ")", "# create new...
Deploys a new satellite app over any existing app
[ "Deploys", "a", "new", "satellite", "app", "over", "any", "existing", "app" ]
train
https://github.com/progrium/skypipe/blob/6162610a1876282ff1cc8eeca6c8669b8f605482/skypipe/cloud.py#L125-L204
podhmo/alchemyjsonschema
alchemyjsonschema/compat.py
bytes_
def bytes_(s, encoding='utf-8', errors='strict'): """ If ``s`` is an instance of ``text_type``, return ``s.encode(encoding, errors)``, otherwise return ``s``""" if isinstance(s, text_type): # pragma: no cover return s.encode(encoding, errors) return s
python
def bytes_(s, encoding='utf-8', errors='strict'): """ If ``s`` is an instance of ``text_type``, return ``s.encode(encoding, errors)``, otherwise return ``s``""" if isinstance(s, text_type): # pragma: no cover return s.encode(encoding, errors) return s
[ "def", "bytes_", "(", "s", ",", "encoding", "=", "'utf-8'", ",", "errors", "=", "'strict'", ")", ":", "if", "isinstance", "(", "s", ",", "text_type", ")", ":", "# pragma: no cover", "return", "s", ".", "encode", "(", "encoding", ",", "errors", ")", "re...
If ``s`` is an instance of ``text_type``, return ``s.encode(encoding, errors)``, otherwise return ``s``
[ "If", "s", "is", "an", "instance", "of", "text_type", "return", "s", ".", "encode", "(", "encoding", "errors", ")", "otherwise", "return", "s" ]
train
https://github.com/podhmo/alchemyjsonschema/blob/0c1da7238413613b1fd21aa31563de948808e3c8/alchemyjsonschema/compat.py#L33-L38
opengisch/pum
pum/core/dumper.py
Dumper.pg_backup
def pg_backup(self, pg_dump_exe='pg_dump', exclude_schema=None): """Call the pg_dump command to create a db backup Parameters ---------- pg_dump_exe: str the pg_dump command path exclude_schema: str[] list of schemas to be skipped """ com...
python
def pg_backup(self, pg_dump_exe='pg_dump', exclude_schema=None): """Call the pg_dump command to create a db backup Parameters ---------- pg_dump_exe: str the pg_dump command path exclude_schema: str[] list of schemas to be skipped """ com...
[ "def", "pg_backup", "(", "self", ",", "pg_dump_exe", "=", "'pg_dump'", ",", "exclude_schema", "=", "None", ")", ":", "command", "=", "[", "pg_dump_exe", ",", "'-Fc'", ",", "'-f'", ",", "self", ".", "file", ",", "'service={}'", ".", "format", "(", "self",...
Call the pg_dump command to create a db backup Parameters ---------- pg_dump_exe: str the pg_dump command path exclude_schema: str[] list of schemas to be skipped
[ "Call", "the", "pg_dump", "command", "to", "create", "a", "db", "backup" ]
train
https://github.com/opengisch/pum/blob/eaf6af92d723ace60b9e982d7f69b98e00606959/pum/core/dumper.py#L17-L35
opengisch/pum
pum/core/dumper.py
Dumper.pg_restore
def pg_restore(self, pg_restore_exe='pg_restore', exclude_schema=None): """Call the pg_restore command to restore a db backup Parameters ---------- pg_restore_exe: str the pg_restore command path """ command = [ pg_restore_exe, '-d', ...
python
def pg_restore(self, pg_restore_exe='pg_restore', exclude_schema=None): """Call the pg_restore command to restore a db backup Parameters ---------- pg_restore_exe: str the pg_restore command path """ command = [ pg_restore_exe, '-d', ...
[ "def", "pg_restore", "(", "self", ",", "pg_restore_exe", "=", "'pg_restore'", ",", "exclude_schema", "=", "None", ")", ":", "command", "=", "[", "pg_restore_exe", ",", "'-d'", ",", "'service={}'", ".", "format", "(", "self", ".", "pg_service", ")", ",", "'...
Call the pg_restore command to restore a db backup Parameters ---------- pg_restore_exe: str the pg_restore command path
[ "Call", "the", "pg_restore", "command", "to", "restore", "a", "db", "backup" ]
train
https://github.com/opengisch/pum/blob/eaf6af92d723ace60b9e982d7f69b98e00606959/pum/core/dumper.py#L37-L67
opengisch/pum
pum/core/upgrader.py
Upgrader.exists_table_upgrades
def exists_table_upgrades(self): """Return if the upgrades table exists Returns ------- bool True if the table exists False if the table don't exists""" query = """ SELECT EXISTS ( SELECT 1 FROM information_schema.ta...
python
def exists_table_upgrades(self): """Return if the upgrades table exists Returns ------- bool True if the table exists False if the table don't exists""" query = """ SELECT EXISTS ( SELECT 1 FROM information_schema.ta...
[ "def", "exists_table_upgrades", "(", "self", ")", ":", "query", "=", "\"\"\"\n SELECT EXISTS (\n SELECT 1\n FROM information_schema.tables\n WHERE table_schema = '{}'\n AND table_name = '{}'\n );\n \"\"\"", ".", "form...
Return if the upgrades table exists Returns ------- bool True if the table exists False if the table don't exists
[ "Return", "if", "the", "upgrades", "table", "exists" ]
train
https://github.com/opengisch/pum/blob/eaf6af92d723ace60b9e982d7f69b98e00606959/pum/core/upgrader.py#L91-L111
opengisch/pum
pum/core/upgrader.py
Upgrader.__get_delta_files
def __get_delta_files(self): """Search for delta files and return a dict of Delta objects, keyed by directory names.""" files = [(d, f) for d in self.dirs for f in listdir(d) if isfile(join(d, f))] deltas = OrderedDict() for d, f in files: file_ = join(d, f) if ...
python
def __get_delta_files(self): """Search for delta files and return a dict of Delta objects, keyed by directory names.""" files = [(d, f) for d in self.dirs for f in listdir(d) if isfile(join(d, f))] deltas = OrderedDict() for d, f in files: file_ = join(d, f) if ...
[ "def", "__get_delta_files", "(", "self", ")", ":", "files", "=", "[", "(", "d", ",", "f", ")", "for", "d", "in", "self", ".", "dirs", "for", "f", "in", "listdir", "(", "d", ")", "if", "isfile", "(", "join", "(", "d", ",", "f", ")", ")", "]", ...
Search for delta files and return a dict of Delta objects, keyed by directory names.
[ "Search", "for", "delta", "files", "and", "return", "a", "dict", "of", "Delta", "objects", "keyed", "by", "directory", "names", "." ]
train
https://github.com/opengisch/pum/blob/eaf6af92d723ace60b9e982d7f69b98e00606959/pum/core/upgrader.py#L121-L142
opengisch/pum
pum/core/upgrader.py
Upgrader.__run_delta_sql
def __run_delta_sql(self, delta): """Execute the delta sql file on the database""" self.__run_sql_file(delta.get_file()) self.__update_upgrades_table(delta)
python
def __run_delta_sql(self, delta): """Execute the delta sql file on the database""" self.__run_sql_file(delta.get_file()) self.__update_upgrades_table(delta)
[ "def", "__run_delta_sql", "(", "self", ",", "delta", ")", ":", "self", ".", "__run_sql_file", "(", "delta", ".", "get_file", "(", ")", ")", "self", ".", "__update_upgrades_table", "(", "delta", ")" ]
Execute the delta sql file on the database
[ "Execute", "the", "delta", "sql", "file", "on", "the", "database" ]
train
https://github.com/opengisch/pum/blob/eaf6af92d723ace60b9e982d7f69b98e00606959/pum/core/upgrader.py#L144-L148
opengisch/pum
pum/core/upgrader.py
Upgrader.__run_delta_py
def __run_delta_py(self, delta): """Execute the delta py file""" self.__run_py_file(delta.get_file(), delta.get_name()) self.__update_upgrades_table(delta)
python
def __run_delta_py(self, delta): """Execute the delta py file""" self.__run_py_file(delta.get_file(), delta.get_name()) self.__update_upgrades_table(delta)
[ "def", "__run_delta_py", "(", "self", ",", "delta", ")", ":", "self", ".", "__run_py_file", "(", "delta", ".", "get_file", "(", ")", ",", "delta", ".", "get_name", "(", ")", ")", "self", ".", "__update_upgrades_table", "(", "delta", ")" ]
Execute the delta py file
[ "Execute", "the", "delta", "py", "file" ]
train
https://github.com/opengisch/pum/blob/eaf6af92d723ace60b9e982d7f69b98e00606959/pum/core/upgrader.py#L150-L154
opengisch/pum
pum/core/upgrader.py
Upgrader.__run_pre_all
def __run_pre_all(self): """Execute the pre-all.py and pre-all.sql files if they exist""" # if the list of delta dirs is [delta1, delta2] the pre scripts of delta2 are # executed before the pre scripts of delta1 for d in reversed(self.dirs): pre_all_py_path = os.path.join(d...
python
def __run_pre_all(self): """Execute the pre-all.py and pre-all.sql files if they exist""" # if the list of delta dirs is [delta1, delta2] the pre scripts of delta2 are # executed before the pre scripts of delta1 for d in reversed(self.dirs): pre_all_py_path = os.path.join(d...
[ "def", "__run_pre_all", "(", "self", ")", ":", "# if the list of delta dirs is [delta1, delta2] the pre scripts of delta2 are", "# executed before the pre scripts of delta1", "for", "d", "in", "reversed", "(", "self", ".", "dirs", ")", ":", "pre_all_py_path", "=", "os", "."...
Execute the pre-all.py and pre-all.sql files if they exist
[ "Execute", "the", "pre", "-", "all", ".", "py", "and", "pre", "-", "all", ".", "sql", "files", "if", "they", "exist" ]
train
https://github.com/opengisch/pum/blob/eaf6af92d723ace60b9e982d7f69b98e00606959/pum/core/upgrader.py#L156-L173
opengisch/pum
pum/core/upgrader.py
Upgrader.__run_post_all
def __run_post_all(self): """Execute the post-all.py and post-all.sql files if they exist""" # if the list of delta dirs is [delta1, delta2] the post scripts of delta1 are # executed before the post scripts of delta2 for d in self.dirs: post_all_py_path = os.path.join(d, 'p...
python
def __run_post_all(self): """Execute the post-all.py and post-all.sql files if they exist""" # if the list of delta dirs is [delta1, delta2] the post scripts of delta1 are # executed before the post scripts of delta2 for d in self.dirs: post_all_py_path = os.path.join(d, 'p...
[ "def", "__run_post_all", "(", "self", ")", ":", "# if the list of delta dirs is [delta1, delta2] the post scripts of delta1 are", "# executed before the post scripts of delta2", "for", "d", "in", "self", ".", "dirs", ":", "post_all_py_path", "=", "os", ".", "path", ".", "jo...
Execute the post-all.py and post-all.sql files if they exist
[ "Execute", "the", "post", "-", "all", ".", "py", "and", "post", "-", "all", ".", "sql", "files", "if", "they", "exist" ]
train
https://github.com/opengisch/pum/blob/eaf6af92d723ace60b9e982d7f69b98e00606959/pum/core/upgrader.py#L175-L192
opengisch/pum
pum/core/upgrader.py
Upgrader.__run_sql_file
def __run_sql_file(self, filepath): """Execute the sql file at the passed path Parameters ---------- filepath: str the path of the file to execute""" with open(filepath, 'r') as delta_file: sql = delta_file.read() if self.variables: ...
python
def __run_sql_file(self, filepath): """Execute the sql file at the passed path Parameters ---------- filepath: str the path of the file to execute""" with open(filepath, 'r') as delta_file: sql = delta_file.read() if self.variables: ...
[ "def", "__run_sql_file", "(", "self", ",", "filepath", ")", ":", "with", "open", "(", "filepath", ",", "'r'", ")", "as", "delta_file", ":", "sql", "=", "delta_file", ".", "read", "(", ")", "if", "self", ".", "variables", ":", "self", ".", "cursor", "...
Execute the sql file at the passed path Parameters ---------- filepath: str the path of the file to execute
[ "Execute", "the", "sql", "file", "at", "the", "passed", "path" ]
train
https://github.com/opengisch/pum/blob/eaf6af92d723ace60b9e982d7f69b98e00606959/pum/core/upgrader.py#L194-L208
opengisch/pum
pum/core/upgrader.py
Upgrader.__run_py_file
def __run_py_file(self, filepath, module_name): """Execute the python file at the passed path Parameters ---------- filepath: str the path of the file to execute module_name: str the name of the python module """ # Import the module ...
python
def __run_py_file(self, filepath, module_name): """Execute the python file at the passed path Parameters ---------- filepath: str the path of the file to execute module_name: str the name of the python module """ # Import the module ...
[ "def", "__run_py_file", "(", "self", ",", "filepath", ",", "module_name", ")", ":", "# Import the module", "spec", "=", "importlib", ".", "util", ".", "spec_from_file_location", "(", "module_name", ",", "filepath", ")", "delta_py", "=", "importlib", ".", "util",...
Execute the python file at the passed path Parameters ---------- filepath: str the path of the file to execute module_name: str the name of the python module
[ "Execute", "the", "python", "file", "at", "the", "passed", "path" ]
train
https://github.com/opengisch/pum/blob/eaf6af92d723ace60b9e982d7f69b98e00606959/pum/core/upgrader.py#L210-L240
opengisch/pum
pum/core/upgrader.py
Upgrader.show_info
def show_info(self): """Print info about found delta files and about already made upgrades""" deltas = self.__get_delta_files() table = [['Version', 'Name', 'Type', 'Status']] for dir_ in deltas: print('delta files in dir: ', dir_) for delta in deltas[dir_]: ...
python
def show_info(self): """Print info about found delta files and about already made upgrades""" deltas = self.__get_delta_files() table = [['Version', 'Name', 'Type', 'Status']] for dir_ in deltas: print('delta files in dir: ', dir_) for delta in deltas[dir_]: ...
[ "def", "show_info", "(", "self", ")", ":", "deltas", "=", "self", ".", "__get_delta_files", "(", ")", "table", "=", "[", "[", "'Version'", ",", "'Name'", ",", "'Type'", ",", "'Status'", "]", "]", "for", "dir_", "in", "deltas", ":", "print", "(", "'de...
Print info about found delta files and about already made upgrades
[ "Print", "info", "about", "found", "delta", "files", "and", "about", "already", "made", "upgrades" ]
train
https://github.com/opengisch/pum/blob/eaf6af92d723ace60b9e982d7f69b98e00606959/pum/core/upgrader.py#L242-L324
opengisch/pum
pum/core/upgrader.py
Upgrader.__print_table
def __print_table(table): """Print a list in tabular format Based on https://stackoverflow.com/a/8356620""" col_width = [max(len(x) for x in col) for col in zip(*table)] print("| " + " | ".join("{:{}}".format(x, col_width[i]) for i, x in enumerate(table[0...
python
def __print_table(table): """Print a list in tabular format Based on https://stackoverflow.com/a/8356620""" col_width = [max(len(x) for x in col) for col in zip(*table)] print("| " + " | ".join("{:{}}".format(x, col_width[i]) for i, x in enumerate(table[0...
[ "def", "__print_table", "(", "table", ")", ":", "col_width", "=", "[", "max", "(", "len", "(", "x", ")", "for", "x", "in", "col", ")", "for", "col", "in", "zip", "(", "*", "table", ")", "]", "print", "(", "\"| \"", "+", "\" | \"", ".", "join", ...
Print a list in tabular format Based on https://stackoverflow.com/a/8356620
[ "Print", "a", "list", "in", "tabular", "format", "Based", "on", "https", ":", "//", "stackoverflow", ".", "com", "/", "a", "/", "8356620" ]
train
https://github.com/opengisch/pum/blob/eaf6af92d723ace60b9e982d7f69b98e00606959/pum/core/upgrader.py#L327-L338
opengisch/pum
pum/core/upgrader.py
Upgrader.__is_applied
def __is_applied(self, delta): """Verifies if delta file is already applied on database Parameters ---------- delta: Delta object The delta object representing the delta file Returns ------- bool True if the delta is already applied on th...
python
def __is_applied(self, delta): """Verifies if delta file is already applied on database Parameters ---------- delta: Delta object The delta object representing the delta file Returns ------- bool True if the delta is already applied on th...
[ "def", "__is_applied", "(", "self", ",", "delta", ")", ":", "query", "=", "\"\"\"\n SELECT id FROM {}\n WHERE version = '{}'\n AND checksum = '{}'\n AND success = 'TRUE'\n \"\"\"", ".", "format", "(", "self", ".", "upgrades_table", ",", ...
Verifies if delta file is already applied on database Parameters ---------- delta: Delta object The delta object representing the delta file Returns ------- bool True if the delta is already applied on the db False otherwise
[ "Verifies", "if", "delta", "file", "is", "already", "applied", "on", "database" ]
train
https://github.com/opengisch/pum/blob/eaf6af92d723ace60b9e982d7f69b98e00606959/pum/core/upgrader.py#L340-L367
opengisch/pum
pum/core/upgrader.py
Upgrader.__update_upgrades_table
def __update_upgrades_table(self, delta): """Add a new record into the upgrades information table about the applied delta Parameters ---------- delta: Delta the applied delta file""" query = """ INSERT INTO {} ( --id, version,...
python
def __update_upgrades_table(self, delta): """Add a new record into the upgrades information table about the applied delta Parameters ---------- delta: Delta the applied delta file""" query = """ INSERT INTO {} ( --id, version,...
[ "def", "__update_upgrades_table", "(", "self", ",", "delta", ")", ":", "query", "=", "\"\"\"\n INSERT INTO {} (\n --id,\n version,\n description,\n type,\n script,\n checksum,\n installed_by,\n --insta...
Add a new record into the upgrades information table about the applied delta Parameters ---------- delta: Delta the applied delta file
[ "Add", "a", "new", "record", "into", "the", "upgrades", "information", "table", "about", "the", "applied", "delta" ]
train
https://github.com/opengisch/pum/blob/eaf6af92d723ace60b9e982d7f69b98e00606959/pum/core/upgrader.py#L369-L405
opengisch/pum
pum/core/upgrader.py
Upgrader.create_upgrades_table
def create_upgrades_table(self): """Create the upgrades information table""" query = """CREATE TABLE IF NOT EXISTS {} ( id serial NOT NULL, version character varying(50), description character varying(200) NOT NULL, type in...
python
def create_upgrades_table(self): """Create the upgrades information table""" query = """CREATE TABLE IF NOT EXISTS {} ( id serial NOT NULL, version character varying(50), description character varying(200) NOT NULL, type in...
[ "def", "create_upgrades_table", "(", "self", ")", ":", "query", "=", "\"\"\"CREATE TABLE IF NOT EXISTS {}\n (\n id serial NOT NULL,\n version character varying(50),\n description character varying(200) NOT NULL,\n type intege...
Create the upgrades information table
[ "Create", "the", "upgrades", "information", "table" ]
train
https://github.com/opengisch/pum/blob/eaf6af92d723ace60b9e982d7f69b98e00606959/pum/core/upgrader.py#L407-L427
opengisch/pum
pum/core/upgrader.py
Upgrader.set_baseline
def set_baseline(self, version): """Set the baseline into the creation information table version: str The version of the current database to set in the information table. The baseline must be in the format x.x.x where x are numbers. """ pattern = re.compile(r"^\d...
python
def set_baseline(self, version): """Set the baseline into the creation information table version: str The version of the current database to set in the information table. The baseline must be in the format x.x.x where x are numbers. """ pattern = re.compile(r"^\d...
[ "def", "set_baseline", "(", "self", ",", "version", ")", ":", "pattern", "=", "re", ".", "compile", "(", "r\"^\\d+\\.\\d+\\.\\d+$\"", ")", "if", "not", "re", ".", "match", "(", "pattern", ",", "version", ")", ":", "raise", "ValueError", "(", "'Wrong versio...
Set the baseline into the creation information table version: str The version of the current database to set in the information table. The baseline must be in the format x.x.x where x are numbers.
[ "Set", "the", "baseline", "into", "the", "creation", "information", "table" ]
train
https://github.com/opengisch/pum/blob/eaf6af92d723ace60b9e982d7f69b98e00606959/pum/core/upgrader.py#L429-L462
opengisch/pum
pum/core/upgrader.py
Upgrader.current_db_version
def current_db_version(self): """Read the upgrades information table and return the current db version Returns ------- str the current db version """ query = """ SELECT version from {} WHERE success = TRUE ORDER BY version DESC """.fo...
python
def current_db_version(self): """Read the upgrades information table and return the current db version Returns ------- str the current db version """ query = """ SELECT version from {} WHERE success = TRUE ORDER BY version DESC """.fo...
[ "def", "current_db_version", "(", "self", ")", ":", "query", "=", "\"\"\"\n SELECT version from {} WHERE success = TRUE ORDER BY version DESC\n \"\"\"", ".", "format", "(", "self", ".", "upgrades_table", ")", "self", ".", "cursor", ".", "execute", "(", "quer...
Read the upgrades information table and return the current db version Returns ------- str the current db version
[ "Read", "the", "upgrades", "information", "table", "and", "return", "the", "current", "db", "version" ]
train
https://github.com/opengisch/pum/blob/eaf6af92d723ace60b9e982d7f69b98e00606959/pum/core/upgrader.py#L464-L480
opengisch/pum
pum/core/upgrader.py
Delta.is_valid_delta_name
def is_valid_delta_name(file): """Return if a file has a valid name A delta file name can be: - pre-all.py - pre-all.sql - delta_x.x.x_ddmmyyyy.pre.py - delta_x.x.x_ddmmyyyy.pre.sql - delta_x.x.x_ddmmyyyy.py - delta_x.x.x_ddmmyyyy.sql - delta_x.x....
python
def is_valid_delta_name(file): """Return if a file has a valid name A delta file name can be: - pre-all.py - pre-all.sql - delta_x.x.x_ddmmyyyy.pre.py - delta_x.x.x_ddmmyyyy.pre.sql - delta_x.x.x_ddmmyyyy.py - delta_x.x.x_ddmmyyyy.sql - delta_x.x....
[ "def", "is_valid_delta_name", "(", "file", ")", ":", "filename", "=", "basename", "(", "file", ")", "pattern", "=", "re", ".", "compile", "(", "Delta", ".", "FILENAME_PATTERN", ")", "if", "re", ".", "match", "(", "pattern", ",", "filename", ")", ":", "...
Return if a file has a valid name A delta file name can be: - pre-all.py - pre-all.sql - delta_x.x.x_ddmmyyyy.pre.py - delta_x.x.x_ddmmyyyy.pre.sql - delta_x.x.x_ddmmyyyy.py - delta_x.x.x_ddmmyyyy.sql - delta_x.x.x_ddmmyyyy.post.py - delta_x.x.x_d...
[ "Return", "if", "a", "file", "has", "a", "valid", "name" ]
train
https://github.com/opengisch/pum/blob/eaf6af92d723ace60b9e982d7f69b98e00606959/pum/core/upgrader.py#L505-L527
opengisch/pum
pum/core/upgrader.py
Delta.get_checksum
def get_checksum(self): """Return the md5 checksum of the delta file.""" with open(self.file, 'rb') as f: cs = md5(f.read()).hexdigest() return cs
python
def get_checksum(self): """Return the md5 checksum of the delta file.""" with open(self.file, 'rb') as f: cs = md5(f.read()).hexdigest() return cs
[ "def", "get_checksum", "(", "self", ")", ":", "with", "open", "(", "self", ".", "file", ",", "'rb'", ")", "as", "f", ":", "cs", "=", "md5", "(", "f", ".", "read", "(", ")", ")", ".", "hexdigest", "(", ")", "return", "cs" ]
Return the md5 checksum of the delta file.
[ "Return", "the", "md5", "checksum", "of", "the", "delta", "file", "." ]
train
https://github.com/opengisch/pum/blob/eaf6af92d723ace60b9e982d7f69b98e00606959/pum/core/upgrader.py#L546-L550
opengisch/pum
pum/core/upgrader.py
Delta.get_type
def get_type(self): """Return the type of the delta file. Returns ------- type: int """ ext = self.match.group(5) if ext == 'pre.py': return DeltaType.PRE_PYTHON elif ext == 'pre.sql': return DeltaType.PRE_SQL elif ext ==...
python
def get_type(self): """Return the type of the delta file. Returns ------- type: int """ ext = self.match.group(5) if ext == 'pre.py': return DeltaType.PRE_PYTHON elif ext == 'pre.sql': return DeltaType.PRE_SQL elif ext ==...
[ "def", "get_type", "(", "self", ")", ":", "ext", "=", "self", ".", "match", ".", "group", "(", "5", ")", "if", "ext", "==", "'pre.py'", ":", "return", "DeltaType", ".", "PRE_PYTHON", "elif", "ext", "==", "'pre.sql'", ":", "return", "DeltaType", ".", ...
Return the type of the delta file. Returns ------- type: int
[ "Return", "the", "type", "of", "the", "delta", "file", "." ]
train
https://github.com/opengisch/pum/blob/eaf6af92d723ace60b9e982d7f69b98e00606959/pum/core/upgrader.py#L552-L573
opengisch/pum
pum/core/upgrader.py
Delta.get_priority
def get_priority(self) -> int: """ Rerturns the priority of the file from 1 (pre) to 3 (post) :return: the priority """ dtype = self.get_type() if dtype & DeltaType.PRE: return 1 elif dtype & DeltaType.POST: return 3 else: ...
python
def get_priority(self) -> int: """ Rerturns the priority of the file from 1 (pre) to 3 (post) :return: the priority """ dtype = self.get_type() if dtype & DeltaType.PRE: return 1 elif dtype & DeltaType.POST: return 3 else: ...
[ "def", "get_priority", "(", "self", ")", "->", "int", ":", "dtype", "=", "self", ".", "get_type", "(", ")", "if", "dtype", "&", "DeltaType", ".", "PRE", ":", "return", "1", "elif", "dtype", "&", "DeltaType", ".", "POST", ":", "return", "3", "else", ...
Rerturns the priority of the file from 1 (pre) to 3 (post) :return: the priority
[ "Rerturns", "the", "priority", "of", "the", "file", "from", "1", "(", "pre", ")", "to", "3", "(", "post", ")", ":", "return", ":", "the", "priority" ]
train
https://github.com/opengisch/pum/blob/eaf6af92d723ace60b9e982d7f69b98e00606959/pum/core/upgrader.py#L575-L586
opengisch/pum
pum/core/deltapy.py
DeltaPy.variable
def variable(self, name: str, default_value=None): """ Safely returns the value of the variable given in PUM Parameters ---------- name the name of the variable default_value the default value for the variable if it does not exist """ ...
python
def variable(self, name: str, default_value=None): """ Safely returns the value of the variable given in PUM Parameters ---------- name the name of the variable default_value the default value for the variable if it does not exist """ ...
[ "def", "variable", "(", "self", ",", "name", ":", "str", ",", "default_value", "=", "None", ")", ":", "return", "self", ".", "__variables", ".", "get", "(", "name", ",", "default_value", ")" ]
Safely returns the value of the variable given in PUM Parameters ---------- name the name of the variable default_value the default value for the variable if it does not exist
[ "Safely", "returns", "the", "value", "of", "the", "variable", "given", "in", "PUM" ]
train
https://github.com/opengisch/pum/blob/eaf6af92d723ace60b9e982d7f69b98e00606959/pum/core/deltapy.py#L64-L75
opengisch/pum
pum/core/checker.py
Checker.run_checks
def run_checks(self): """Run all the checks functions. Returns ------- bool True if all the checks are true False otherwise dict Dictionary of lists of differences """ result = True differen...
python
def run_checks(self): """Run all the checks functions. Returns ------- bool True if all the checks are true False otherwise dict Dictionary of lists of differences """ result = True differen...
[ "def", "run_checks", "(", "self", ")", ":", "result", "=", "True", "differences_dict", "=", "{", "}", "if", "'tables'", "not", "in", "self", ".", "ignore_list", ":", "tmp_result", ",", "differences_dict", "[", "'tables'", "]", "=", "self", ".", "check_tabl...
Run all the checks functions. Returns ------- bool True if all the checks are true False otherwise dict Dictionary of lists of differences
[ "Run", "all", "the", "checks", "functions", "." ]
train
https://github.com/opengisch/pum/blob/eaf6af92d723ace60b9e982d7f69b98e00606959/pum/core/checker.py#L51-L97
opengisch/pum
pum/core/checker.py
Checker.check_columns
def check_columns(self, check_views=True): """Check if the columns in all tables are equals. Parameters ---------- check_views: bool if True, check the columns of all the tables and views, if False check only the columns of the tables ...
python
def check_columns(self, check_views=True): """Check if the columns in all tables are equals. Parameters ---------- check_views: bool if True, check the columns of all the tables and views, if False check only the columns of the tables ...
[ "def", "check_columns", "(", "self", ",", "check_views", "=", "True", ")", ":", "if", "check_views", ":", "query", "=", "\"\"\"WITH table_list AS (\n SELECT table_schema, table_name\n FROM information_schema.tables\n WHERE table_schema NOT I...
Check if the columns in all tables are equals. Parameters ---------- check_views: bool if True, check the columns of all the tables and views, if False check only the columns of the tables Returns ------- bool ...
[ "Check", "if", "the", "columns", "in", "all", "tables", "are", "equals", "." ]
train
https://github.com/opengisch/pum/blob/eaf6af92d723ace60b9e982d7f69b98e00606959/pum/core/checker.py#L120-L176
opengisch/pum
pum/core/checker.py
Checker.check_rules
def check_rules(self): """Check if the rules are equals. Returns ------- bool True if the rules are the same False otherwise list A list with the differences """ query = """ select n.nspname ...
python
def check_rules(self): """Check if the rules are equals. Returns ------- bool True if the rules are the same False otherwise list A list with the differences """ query = """ select n.nspname ...
[ "def", "check_rules", "(", "self", ")", ":", "query", "=", "\"\"\"\n select n.nspname as rule_schema,\n c.relname as rule_table,\n case r.ev_type\n when '1' then 'SELECT'\n when '2' then 'UPDATE'\n when '3' then 'INSERT'\n when '4' the...
Check if the rules are equals. Returns ------- bool True if the rules are the same False otherwise list A list with the differences
[ "Check", "if", "the", "rules", "are", "equals", "." ]
train
https://github.com/opengisch/pum/blob/eaf6af92d723ace60b9e982d7f69b98e00606959/pum/core/checker.py#L342-L373
opengisch/pum
pum/core/checker.py
Checker.__check_equals
def __check_equals(self, query): """Check if the query results on the two databases are equals. Returns ------- bool True if the results are the same False otherwise list A list with the differences """ ...
python
def __check_equals(self, query): """Check if the query results on the two databases are equals. Returns ------- bool True if the results are the same False otherwise list A list with the differences """ ...
[ "def", "__check_equals", "(", "self", ",", "query", ")", ":", "self", ".", "cur1", ".", "execute", "(", "query", ")", "records1", "=", "self", ".", "cur1", ".", "fetchall", "(", ")", "self", ".", "cur2", ".", "execute", "(", "query", ")", "records2",...
Check if the query results on the two databases are equals. Returns ------- bool True if the results are the same False otherwise list A list with the differences
[ "Check", "if", "the", "query", "results", "on", "the", "two", "databases", "are", "equals", "." ]
train
https://github.com/opengisch/pum/blob/eaf6af92d723ace60b9e982d7f69b98e00606959/pum/core/checker.py#L375-L407
opengisch/pum
pum/utils/utils.py
ask_for_confirmation
def ask_for_confirmation(prompt=None, resp=False): """Prompt for a yes or no response from the user. Parameters ---------- prompt: basestring The question to be prompted to the user. resp: bool The default value assumed by the caller when user simply ...
python
def ask_for_confirmation(prompt=None, resp=False): """Prompt for a yes or no response from the user. Parameters ---------- prompt: basestring The question to be prompted to the user. resp: bool The default value assumed by the caller when user simply ...
[ "def", "ask_for_confirmation", "(", "prompt", "=", "None", ",", "resp", "=", "False", ")", ":", "global", "input", "if", "prompt", "is", "None", ":", "prompt", "=", "'Confirm'", "if", "resp", ":", "prompt", "=", "'%s [%s]|%s: '", "%", "(", "prompt", ",",...
Prompt for a yes or no response from the user. Parameters ---------- prompt: basestring The question to be prompted to the user. resp: bool The default value assumed by the caller when user simply types ENTER. Returns ------- ...
[ "Prompt", "for", "a", "yes", "or", "no", "response", "from", "the", "user", "." ]
train
https://github.com/opengisch/pum/blob/eaf6af92d723ace60b9e982d7f69b98e00606959/pum/utils/utils.py#L4-L45
Jaymon/endpoints
endpoints/decorators/auth.py
AuthDecorator.handle_target
def handle_target(self, request, controller_args, controller_kwargs): """Only here to set self.request and get rid of it after this will set self.request so the target method can access request using self.request, just like in the controller. """ self.request = request s...
python
def handle_target(self, request, controller_args, controller_kwargs): """Only here to set self.request and get rid of it after this will set self.request so the target method can access request using self.request, just like in the controller. """ self.request = request s...
[ "def", "handle_target", "(", "self", ",", "request", ",", "controller_args", ",", "controller_kwargs", ")", ":", "self", ".", "request", "=", "request", "super", "(", "AuthDecorator", ",", "self", ")", ".", "handle_target", "(", "request", ",", "controller_arg...
Only here to set self.request and get rid of it after this will set self.request so the target method can access request using self.request, just like in the controller.
[ "Only", "here", "to", "set", "self", ".", "request", "and", "get", "rid", "of", "it", "after" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/decorators/auth.py#L190-L198
Jaymon/endpoints
endpoints/client.py
HTTPClient.get
def get(self, uri, query=None, **kwargs): """make a GET request""" return self.fetch('get', uri, query, **kwargs)
python
def get(self, uri, query=None, **kwargs): """make a GET request""" return self.fetch('get', uri, query, **kwargs)
[ "def", "get", "(", "self", ",", "uri", ",", "query", "=", "None", ",", "*", "*", "kwargs", ")", ":", "return", "self", ".", "fetch", "(", "'get'", ",", "uri", ",", "query", ",", "*", "*", "kwargs", ")" ]
make a GET request
[ "make", "a", "GET", "request" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/client.py#L41-L43
Jaymon/endpoints
endpoints/client.py
HTTPClient.post
def post(self, uri, body=None, **kwargs): """make a POST request""" return self.fetch('post', uri, kwargs.pop("query", {}), body, **kwargs)
python
def post(self, uri, body=None, **kwargs): """make a POST request""" return self.fetch('post', uri, kwargs.pop("query", {}), body, **kwargs)
[ "def", "post", "(", "self", ",", "uri", ",", "body", "=", "None", ",", "*", "*", "kwargs", ")", ":", "return", "self", ".", "fetch", "(", "'post'", ",", "uri", ",", "kwargs", ".", "pop", "(", "\"query\"", ",", "{", "}", ")", ",", "body", ",", ...
make a POST request
[ "make", "a", "POST", "request" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/client.py#L45-L47
Jaymon/endpoints
endpoints/client.py
HTTPClient.post_file
def post_file(self, uri, body, files, **kwargs): """POST a file""" # requests doesn't actually need us to open the files but we do anyway because # if we don't then the filename isn't preserved, so we assume each string # value is a filepath for key in files.keys(): i...
python
def post_file(self, uri, body, files, **kwargs): """POST a file""" # requests doesn't actually need us to open the files but we do anyway because # if we don't then the filename isn't preserved, so we assume each string # value is a filepath for key in files.keys(): i...
[ "def", "post_file", "(", "self", ",", "uri", ",", "body", ",", "files", ",", "*", "*", "kwargs", ")", ":", "# requests doesn't actually need us to open the files but we do anyway because", "# if we don't then the filename isn't preserved, so we assume each string", "# value is a ...
POST a file
[ "POST", "a", "file" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/client.py#L49-L68
Jaymon/endpoints
endpoints/client.py
HTTPClient.delete
def delete(self, uri, query=None, **kwargs): """make a DELETE request""" return self.fetch('delete', uri, query, **kwargs)
python
def delete(self, uri, query=None, **kwargs): """make a DELETE request""" return self.fetch('delete', uri, query, **kwargs)
[ "def", "delete", "(", "self", ",", "uri", ",", "query", "=", "None", ",", "*", "*", "kwargs", ")", ":", "return", "self", ".", "fetch", "(", "'delete'", ",", "uri", ",", "query", ",", "*", "*", "kwargs", ")" ]
make a DELETE request
[ "make", "a", "DELETE", "request" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/client.py#L70-L72
Jaymon/endpoints
endpoints/client.py
HTTPClient.fetch
def fetch(self, method, uri, query=None, body=None, **kwargs): """ wrapper method that all the top level methods (get, post, etc.) use to actually make the request """ if not query: query = {} fetch_url = self.get_fetch_url(uri, query) args = [fetch_url] ...
python
def fetch(self, method, uri, query=None, body=None, **kwargs): """ wrapper method that all the top level methods (get, post, etc.) use to actually make the request """ if not query: query = {} fetch_url = self.get_fetch_url(uri, query) args = [fetch_url] ...
[ "def", "fetch", "(", "self", ",", "method", ",", "uri", ",", "query", "=", "None", ",", "body", "=", "None", ",", "*", "*", "kwargs", ")", ":", "if", "not", "query", ":", "query", "=", "{", "}", "fetch_url", "=", "self", ".", "get_fetch_url", "("...
wrapper method that all the top level methods (get, post, etc.) use to actually make the request
[ "wrapper", "method", "that", "all", "the", "top", "level", "methods", "(", "get", "post", "etc", ".", ")", "use", "to", "actually", "make", "the", "request" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/client.py#L74-L97
Jaymon/endpoints
endpoints/client.py
HTTPClient.get_fetch_headers
def get_fetch_headers(self, method, headers): """merge class headers with passed in headers :param method: string, (eg, GET or POST), this is passed in so you can customize headers based on the method that you are calling :param headers: dict, all the headers passed into the fetch m...
python
def get_fetch_headers(self, method, headers): """merge class headers with passed in headers :param method: string, (eg, GET or POST), this is passed in so you can customize headers based on the method that you are calling :param headers: dict, all the headers passed into the fetch m...
[ "def", "get_fetch_headers", "(", "self", ",", "method", ",", "headers", ")", ":", "all_headers", "=", "self", ".", "headers", ".", "copy", "(", ")", "if", "headers", ":", "all_headers", ".", "update", "(", "headers", ")", "return", "Headers", "(", "all_h...
merge class headers with passed in headers :param method: string, (eg, GET or POST), this is passed in so you can customize headers based on the method that you are calling :param headers: dict, all the headers passed into the fetch method :returns: passed in headers merged with glo...
[ "merge", "class", "headers", "with", "passed", "in", "headers" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/client.py#L142-L153
Jaymon/endpoints
endpoints/client.py
HTTPClient.get_fetch_request
def get_fetch_request(self, method, fetch_url, *args, **kwargs): """This is handy if you want to modify the request right before passing it to requests, or you want to do something extra special customized :param method: string, the http method (eg, GET, POST) :param fetch_url: string, ...
python
def get_fetch_request(self, method, fetch_url, *args, **kwargs): """This is handy if you want to modify the request right before passing it to requests, or you want to do something extra special customized :param method: string, the http method (eg, GET, POST) :param fetch_url: string, ...
[ "def", "get_fetch_request", "(", "self", ",", "method", ",", "fetch_url", ",", "*", "args", ",", "*", "*", "kwargs", ")", ":", "return", "requests", ".", "request", "(", "method", ",", "fetch_url", ",", "*", "args", ",", "*", "*", "kwargs", ")" ]
This is handy if you want to modify the request right before passing it to requests, or you want to do something extra special customized :param method: string, the http method (eg, GET, POST) :param fetch_url: string, the full url with query params :param *args: any other positional ar...
[ "This", "is", "handy", "if", "you", "want", "to", "modify", "the", "request", "right", "before", "passing", "it", "to", "requests", "or", "you", "want", "to", "do", "something", "extra", "special", "customized" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/client.py#L158-L168
Jaymon/endpoints
endpoints/client.py
HTTPClient.get_fetch_response
def get_fetch_response(self, res): """the goal of this method is to make the requests object more endpoints like res -- requests Response -- the native requests response instance, we manipulate it a bit to make it look a bit more like the internal endpoints.Response object """ ...
python
def get_fetch_response(self, res): """the goal of this method is to make the requests object more endpoints like res -- requests Response -- the native requests response instance, we manipulate it a bit to make it look a bit more like the internal endpoints.Response object """ ...
[ "def", "get_fetch_response", "(", "self", ",", "res", ")", ":", "res", ".", "code", "=", "res", ".", "status_code", "res", ".", "headers", "=", "Headers", "(", "res", ".", "headers", ")", "res", ".", "_body", "=", "None", "res", ".", "body", "=", "...
the goal of this method is to make the requests object more endpoints like res -- requests Response -- the native requests response instance, we manipulate it a bit to make it look a bit more like the internal endpoints.Response object
[ "the", "goal", "of", "this", "method", "is", "to", "make", "the", "requests", "object", "more", "endpoints", "like" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/client.py#L170-L189
Jaymon/endpoints
endpoints/client.py
HTTPClient.is_json
def is_json(self, headers): """return true if content_type is a json content type""" ret = False ct = headers.get("content-type", "").lower() if ct: ret = ct.lower().rfind("json") >= 0 return ret
python
def is_json(self, headers): """return true if content_type is a json content type""" ret = False ct = headers.get("content-type", "").lower() if ct: ret = ct.lower().rfind("json") >= 0 return ret
[ "def", "is_json", "(", "self", ",", "headers", ")", ":", "ret", "=", "False", "ct", "=", "headers", ".", "get", "(", "\"content-type\"", ",", "\"\"", ")", ".", "lower", "(", ")", "if", "ct", ":", "ret", "=", "ct", ".", "lower", "(", ")", ".", "...
return true if content_type is a json content type
[ "return", "true", "if", "content_type", "is", "a", "json", "content", "type" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/client.py#L191-L197
Jaymon/endpoints
endpoints/reflection.py
ReflectMethod.desc
def desc(self): """return the description of this endpoint""" doc = None def visit_FunctionDef(node): """ https://docs.python.org/2/library/ast.html#ast.NodeVisitor.visit """ if node.name != self.method_name: return doc = ast.get_docstring(nod...
python
def desc(self): """return the description of this endpoint""" doc = None def visit_FunctionDef(node): """ https://docs.python.org/2/library/ast.html#ast.NodeVisitor.visit """ if node.name != self.method_name: return doc = ast.get_docstring(nod...
[ "def", "desc", "(", "self", ")", ":", "doc", "=", "None", "def", "visit_FunctionDef", "(", "node", ")", ":", "\"\"\" https://docs.python.org/2/library/ast.html#ast.NodeVisitor.visit \"\"\"", "if", "node", ".", "name", "!=", "self", ".", "method_name", ":", "return",...
return the description of this endpoint
[ "return", "the", "description", "of", "this", "endpoint" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/reflection.py#L83-L104
Jaymon/endpoints
endpoints/reflection.py
ReflectMethod.params
def params(self): """return information about the params that the given http option takes""" ret = {} for rd in self.decorators: args = rd.args kwargs = rd.kwargs if param in rd: is_required = kwargs.get('required', 'default' not in kwargs) ...
python
def params(self): """return information about the params that the given http option takes""" ret = {} for rd in self.decorators: args = rd.args kwargs = rd.kwargs if param in rd: is_required = kwargs.get('required', 'default' not in kwargs) ...
[ "def", "params", "(", "self", ")", ":", "ret", "=", "{", "}", "for", "rd", "in", "self", ".", "decorators", ":", "args", "=", "rd", ".", "args", "kwargs", "=", "rd", ".", "kwargs", "if", "param", "in", "rd", ":", "is_required", "=", "kwargs", "."...
return information about the params that the given http option takes
[ "return", "information", "about", "the", "params", "that", "the", "given", "http", "option", "takes" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/reflection.py#L107-L117
Jaymon/endpoints
endpoints/reflection.py
ReflectController.decorators
def decorators(self): """Get all the decorators of all the option methods in the class http://stackoverflow.com/questions/5910703/ specifically, I used this answer http://stackoverflow.com/a/9580006 """ res = collections.defaultdict(list) mmap = {} def get_val(n...
python
def decorators(self): """Get all the decorators of all the option methods in the class http://stackoverflow.com/questions/5910703/ specifically, I used this answer http://stackoverflow.com/a/9580006 """ res = collections.defaultdict(list) mmap = {} def get_val(n...
[ "def", "decorators", "(", "self", ")", ":", "res", "=", "collections", ".", "defaultdict", "(", "list", ")", "mmap", "=", "{", "}", "def", "get_val", "(", "na", ",", "default", "=", "None", ")", ":", "ret", "=", "None", "if", "isinstance", "(", "na...
Get all the decorators of all the option methods in the class http://stackoverflow.com/questions/5910703/ specifically, I used this answer http://stackoverflow.com/a/9580006
[ "Get", "all", "the", "decorators", "of", "all", "the", "option", "methods", "in", "the", "class" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/reflection.py#L134-L247
Jaymon/endpoints
endpoints/reflection.py
ReflectController.desc
def desc(self): """return the description of this endpoint""" doc = inspect.getdoc(self.controller_class) if not doc: doc = '' return doc
python
def desc(self): """return the description of this endpoint""" doc = inspect.getdoc(self.controller_class) if not doc: doc = '' return doc
[ "def", "desc", "(", "self", ")", ":", "doc", "=", "inspect", ".", "getdoc", "(", "self", ".", "controller_class", ")", "if", "not", "doc", ":", "doc", "=", "''", "return", "doc" ]
return the description of this endpoint
[ "return", "the", "description", "of", "this", "endpoint" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/reflection.py#L277-L281
Jaymon/endpoints
endpoints/reflection.py
ReflectController.methods
def methods(self): """ return the supported http method options that this class supports return what http method options this endpoint supports (eg, POST, GET) http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html :returns: dict, each http method (eg, GET, POST) will have a key...
python
def methods(self): """ return the supported http method options that this class supports return what http method options this endpoint supports (eg, POST, GET) http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html :returns: dict, each http method (eg, GET, POST) will have a key...
[ "def", "methods", "(", "self", ")", ":", "ret", "=", "{", "}", "method_regex", "=", "re", ".", "compile", "(", "r\"^[A-Z][A-Z0-9]+(_|$)\"", ")", "controller_methods", "=", "inspect", ".", "getmembers", "(", "self", ".", "controller_class", ")", "for", "contr...
return the supported http method options that this class supports return what http method options this endpoint supports (eg, POST, GET) http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html :returns: dict, each http method (eg, GET, POST) will have a key with the value being every...
[ "return", "the", "supported", "http", "method", "options", "that", "this", "class", "supports", "return", "what", "http", "method", "options", "this", "endpoint", "supports", "(", "eg", "POST", "GET", ")" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/reflection.py#L284-L309
Jaymon/endpoints
endpoints/interface/__init__.py
BaseServer.create_call
def create_call(self, raw_request, **kwargs): """create a call object that has endpoints understandable request and response instances""" req = self.create_request(raw_request, **kwargs) res = self.create_response(**kwargs) rou = self.create_router(**kwargs) c = self.call...
python
def create_call(self, raw_request, **kwargs): """create a call object that has endpoints understandable request and response instances""" req = self.create_request(raw_request, **kwargs) res = self.create_response(**kwargs) rou = self.create_router(**kwargs) c = self.call...
[ "def", "create_call", "(", "self", ",", "raw_request", ",", "*", "*", "kwargs", ")", ":", "req", "=", "self", ".", "create_request", "(", "raw_request", ",", "*", "*", "kwargs", ")", "res", "=", "self", ".", "create_response", "(", "*", "*", "kwargs", ...
create a call object that has endpoints understandable request and response instances
[ "create", "a", "call", "object", "that", "has", "endpoints", "understandable", "request", "and", "response", "instances" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/interface/__init__.py#L88-L95
Jaymon/endpoints
endpoints/decorators/limit.py
RateLimitDecorator.target
def target(self, request, key, limit, ttl): """this will only run the request if the key has a value, if you want to fail if the key doesn't have a value, then normalize_key() should raise an exception :param request: Request, the request instance :param key: string, the unique ...
python
def target(self, request, key, limit, ttl): """this will only run the request if the key has a value, if you want to fail if the key doesn't have a value, then normalize_key() should raise an exception :param request: Request, the request instance :param key: string, the unique ...
[ "def", "target", "(", "self", ",", "request", ",", "key", ",", "limit", ",", "ttl", ")", ":", "ret", "=", "True", "if", "key", ":", "#backend = self.create_backend()", "#method = getattr(backend, \"normalize_limit\", None)", "#if method:", "# limit = method(request, ...
this will only run the request if the key has a value, if you want to fail if the key doesn't have a value, then normalize_key() should raise an exception :param request: Request, the request instance :param key: string, the unique key for the endpoint, this is generated using ...
[ "this", "will", "only", "run", "the", "request", "if", "the", "key", "has", "a", "value", "if", "you", "want", "to", "fail", "if", "the", "key", "doesn", "t", "have", "a", "value", "then", "normalize_key", "()", "should", "raise", "an", "exception" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/decorators/limit.py#L121-L146
Jaymon/endpoints
endpoints/decorators/limit.py
RateLimitDecorator.decorate
def decorate(self, func, limit=0, ttl=0, *anoop, **kwnoop): """see target for an explanation of limit and ttl""" self.limit = int(limit) self.ttl = int(ttl) return super(RateLimitDecorator, self).decorate(func, target=None, *anoop, **kwnoop)
python
def decorate(self, func, limit=0, ttl=0, *anoop, **kwnoop): """see target for an explanation of limit and ttl""" self.limit = int(limit) self.ttl = int(ttl) return super(RateLimitDecorator, self).decorate(func, target=None, *anoop, **kwnoop)
[ "def", "decorate", "(", "self", ",", "func", ",", "limit", "=", "0", ",", "ttl", "=", "0", ",", "*", "anoop", ",", "*", "*", "kwnoop", ")", ":", "self", ".", "limit", "=", "int", "(", "limit", ")", "self", ".", "ttl", "=", "int", "(", "ttl", ...
see target for an explanation of limit and ttl
[ "see", "target", "for", "an", "explanation", "of", "limit", "and", "ttl" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/decorators/limit.py#L152-L156
Jaymon/endpoints
endpoints/decorators/limit.py
ratelimit.decorate
def decorate(self, func, limit, ttl, *anoop, **kwnoop): """make limit and ttl required""" return super(ratelimit, self).decorate(func, limit, ttl, *anoop, **kwnoop)
python
def decorate(self, func, limit, ttl, *anoop, **kwnoop): """make limit and ttl required""" return super(ratelimit, self).decorate(func, limit, ttl, *anoop, **kwnoop)
[ "def", "decorate", "(", "self", ",", "func", ",", "limit", ",", "ttl", ",", "*", "anoop", ",", "*", "*", "kwnoop", ")", ":", "return", "super", "(", "ratelimit", ",", "self", ")", ".", "decorate", "(", "func", ",", "limit", ",", "ttl", ",", "*", ...
make limit and ttl required
[ "make", "limit", "and", "ttl", "required" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/decorators/limit.py#L179-L181
Jaymon/endpoints
endpoints/bin/wsgiserver.py
console
def console(): ''' cli hook return -- integer -- the exit code ''' parser = argparse.ArgumentParser(description='Start an endpoints WSGI server', add_help=True) #parser.add_argument('--debug', dest='debug', action='store_true', help='print debugging info') parser.add_argument( "-v", ...
python
def console(): ''' cli hook return -- integer -- the exit code ''' parser = argparse.ArgumentParser(description='Start an endpoints WSGI server', add_help=True) #parser.add_argument('--debug', dest='debug', action='store_true', help='print debugging info') parser.add_argument( "-v", ...
[ "def", "console", "(", ")", ":", "parser", "=", "argparse", ".", "ArgumentParser", "(", "description", "=", "'Start an endpoints WSGI server'", ",", "add_help", "=", "True", ")", "#parser.add_argument('--debug', dest='debug', action='store_true', help='print debugging info')", ...
cli hook return -- integer -- the exit code
[ "cli", "hook", "return", "--", "integer", "--", "the", "exit", "code" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/bin/wsgiserver.py#L22-L113
Jaymon/endpoints
endpoints/utils.py
Base64.encode
def encode(cls, s): """converts a plain text string to base64 encoding :param s: unicode str|bytes, the base64 encoded string :returns: unicode str """ b = ByteString(s) be = base64.b64encode(b).strip() return String(be)
python
def encode(cls, s): """converts a plain text string to base64 encoding :param s: unicode str|bytes, the base64 encoded string :returns: unicode str """ b = ByteString(s) be = base64.b64encode(b).strip() return String(be)
[ "def", "encode", "(", "cls", ",", "s", ")", ":", "b", "=", "ByteString", "(", "s", ")", "be", "=", "base64", ".", "b64encode", "(", "b", ")", ".", "strip", "(", ")", "return", "String", "(", "be", ")" ]
converts a plain text string to base64 encoding :param s: unicode str|bytes, the base64 encoded string :returns: unicode str
[ "converts", "a", "plain", "text", "string", "to", "base64", "encoding" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/utils.py#L119-L127
Jaymon/endpoints
endpoints/utils.py
Base64.decode
def decode(cls, s): """decodes a base64 string to plain text :param s: unicode str|bytes, the base64 encoded string :returns: unicode str """ b = ByteString(s) bd = base64.b64decode(b) return String(bd)
python
def decode(cls, s): """decodes a base64 string to plain text :param s: unicode str|bytes, the base64 encoded string :returns: unicode str """ b = ByteString(s) bd = base64.b64decode(b) return String(bd)
[ "def", "decode", "(", "cls", ",", "s", ")", ":", "b", "=", "ByteString", "(", "s", ")", "bd", "=", "base64", ".", "b64decode", "(", "b", ")", "return", "String", "(", "bd", ")" ]
decodes a base64 string to plain text :param s: unicode str|bytes, the base64 encoded string :returns: unicode str
[ "decodes", "a", "base64", "string", "to", "plain", "text" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/utils.py#L130-L138
Jaymon/endpoints
endpoints/utils.py
MimeType.find_type
def find_type(cls, val): """return the mimetype from the given string value if value is a path, then the extension will be found, if val is an extension then that will be used to find the mimetype """ mt = "" index = val.rfind(".") if index == -1: val...
python
def find_type(cls, val): """return the mimetype from the given string value if value is a path, then the extension will be found, if val is an extension then that will be used to find the mimetype """ mt = "" index = val.rfind(".") if index == -1: val...
[ "def", "find_type", "(", "cls", ",", "val", ")", ":", "mt", "=", "\"\"", "index", "=", "val", ".", "rfind", "(", "\".\"", ")", "if", "index", "==", "-", "1", ":", "val", "=", "\"fake.{}\"", ".", "format", "(", "val", ")", "elif", "index", "==", ...
return the mimetype from the given string value if value is a path, then the extension will be found, if val is an extension then that will be used to find the mimetype
[ "return", "the", "mimetype", "from", "the", "given", "string", "value" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/utils.py#L154-L171
Jaymon/endpoints
endpoints/utils.py
AcceptHeader._sort
def _sort(self, a, b): ''' sort the headers according to rfc 2616 so when __iter__ is called, the accept media types are in order from most preferred to least preferred ''' ret = 0 # first we check q, higher values win: if a[1] != b[1]: ret = cmp(a[1]...
python
def _sort(self, a, b): ''' sort the headers according to rfc 2616 so when __iter__ is called, the accept media types are in order from most preferred to least preferred ''' ret = 0 # first we check q, higher values win: if a[1] != b[1]: ret = cmp(a[1]...
[ "def", "_sort", "(", "self", ",", "a", ",", "b", ")", ":", "ret", "=", "0", "# first we check q, higher values win:", "if", "a", "[", "1", "]", "!=", "b", "[", "1", "]", ":", "ret", "=", "cmp", "(", "a", "[", "1", "]", ",", "b", "[", "1", "]"...
sort the headers according to rfc 2616 so when __iter__ is called, the accept media types are in order from most preferred to least preferred
[ "sort", "the", "headers", "according", "to", "rfc", "2616", "so", "when", "__iter__", "is", "called", "the", "accept", "media", "types", "are", "in", "order", "from", "most", "preferred", "to", "least", "preferred" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/utils.py#L211-L244
Jaymon/endpoints
endpoints/utils.py
AcceptHeader.filter
def filter(self, media_type, **params): """ iterate all the accept media types that match media_type media_type -- string -- the media type to filter by **params -- dict -- further filter by key: val return -- generator -- yields all matching media type info things """ ...
python
def filter(self, media_type, **params): """ iterate all the accept media types that match media_type media_type -- string -- the media type to filter by **params -- dict -- further filter by key: val return -- generator -- yields all matching media type info things """ ...
[ "def", "filter", "(", "self", ",", "media_type", ",", "*", "*", "params", ")", ":", "mtype", ",", "msubtype", "=", "self", ".", "_split_media_type", "(", "media_type", ")", "for", "x", "in", "self", ".", "__iter__", "(", ")", ":", "# all the params have ...
iterate all the accept media types that match media_type media_type -- string -- the media type to filter by **params -- dict -- further filter by key: val return -- generator -- yields all matching media type info things
[ "iterate", "all", "the", "accept", "media", "types", "that", "match", "media_type" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/utils.py#L259-L300
Jaymon/endpoints
endpoints/interface/wsgi/__init__.py
Application.create_request
def create_request(self, raw_request, **kwargs): """ create instance of request raw_request -- the raw request object retrieved from a WSGI server """ r = self.request_class() for k, v in raw_request.items(): if k.startswith('HTTP_'): r.set_he...
python
def create_request(self, raw_request, **kwargs): """ create instance of request raw_request -- the raw request object retrieved from a WSGI server """ r = self.request_class() for k, v in raw_request.items(): if k.startswith('HTTP_'): r.set_he...
[ "def", "create_request", "(", "self", ",", "raw_request", ",", "*", "*", "kwargs", ")", ":", "r", "=", "self", ".", "request_class", "(", ")", "for", "k", ",", "v", "in", "raw_request", ".", "items", "(", ")", ":", "if", "k", ".", "startswith", "("...
create instance of request raw_request -- the raw request object retrieved from a WSGI server
[ "create", "instance", "of", "request" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/interface/wsgi/__init__.py#L51-L89
Jaymon/endpoints
endpoints/interface/wsgi/__init__.py
Server.application
def application(self, v): """allow overriding of the application factory, this allows you to set your own application callable that will be used to handle requests, see bin/wsgiserver.py script as an example of usage""" self._application = v self.backend.set_app(v)
python
def application(self, v): """allow overriding of the application factory, this allows you to set your own application callable that will be used to handle requests, see bin/wsgiserver.py script as an example of usage""" self._application = v self.backend.set_app(v)
[ "def", "application", "(", "self", ",", "v", ")", ":", "self", ".", "_application", "=", "v", "self", ".", "backend", ".", "set_app", "(", "v", ")" ]
allow overriding of the application factory, this allows you to set your own application callable that will be used to handle requests, see bin/wsgiserver.py script as an example of usage
[ "allow", "overriding", "of", "the", "application", "factory", "this", "allows", "you", "to", "set", "your", "own", "application", "callable", "that", "will", "be", "used", "to", "handle", "requests", "see", "bin", "/", "wsgiserver", ".", "py", "script", "as"...
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/interface/wsgi/__init__.py#L127-L132
Jaymon/endpoints
endpoints/interface/uwsgi/async.py
WebsocketApplication.create_environ
def create_environ(self, req, payload): """This will take the original request and the new websocket payload and merge them into a new request instance""" ws_req = req.copy() del ws_req.controller_info ws_req.environ.pop("wsgi.input", None) ws_req.body_kwargs = payload....
python
def create_environ(self, req, payload): """This will take the original request and the new websocket payload and merge them into a new request instance""" ws_req = req.copy() del ws_req.controller_info ws_req.environ.pop("wsgi.input", None) ws_req.body_kwargs = payload....
[ "def", "create_environ", "(", "self", ",", "req", ",", "payload", ")", ":", "ws_req", "=", "req", ".", "copy", "(", ")", "del", "ws_req", ".", "controller_info", "ws_req", ".", "environ", ".", "pop", "(", "\"wsgi.input\"", ",", "None", ")", "ws_req", "...
This will take the original request and the new websocket payload and merge them into a new request instance
[ "This", "will", "take", "the", "original", "request", "and", "the", "new", "websocket", "payload", "and", "merge", "them", "into", "a", "new", "request", "instance" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/interface/uwsgi/async.py#L126-L147
Jaymon/endpoints
endpoints/interface/wsgi/client.py
find_module_path
def find_module_path(): """find where the master module is located""" master_modname = __name__.split(".", 1)[0] master_module = sys.modules[master_modname] #return os.path.dirname(os.path.realpath(os.path.join(inspect.getsourcefile(endpoints), ".."))) path = os.path.dirname(inspect.getsourcefile(ma...
python
def find_module_path(): """find where the master module is located""" master_modname = __name__.split(".", 1)[0] master_module = sys.modules[master_modname] #return os.path.dirname(os.path.realpath(os.path.join(inspect.getsourcefile(endpoints), ".."))) path = os.path.dirname(inspect.getsourcefile(ma...
[ "def", "find_module_path", "(", ")", ":", "master_modname", "=", "__name__", ".", "split", "(", "\".\"", ",", "1", ")", "[", "0", "]", "master_module", "=", "sys", ".", "modules", "[", "master_modname", "]", "#return os.path.dirname(os.path.realpath(os.path.join(i...
find where the master module is located
[ "find", "where", "the", "master", "module", "is", "located" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/interface/wsgi/client.py#L17-L23
Jaymon/endpoints
endpoints/http.py
Headers._convert_string_name
def _convert_string_name(self, k): """converts things like FOO_BAR to Foo-Bar which is the normal form""" k = String(k, "iso-8859-1") klower = k.lower().replace('_', '-') bits = klower.split('-') return "-".join((bit.title() for bit in bits))
python
def _convert_string_name(self, k): """converts things like FOO_BAR to Foo-Bar which is the normal form""" k = String(k, "iso-8859-1") klower = k.lower().replace('_', '-') bits = klower.split('-') return "-".join((bit.title() for bit in bits))
[ "def", "_convert_string_name", "(", "self", ",", "k", ")", ":", "k", "=", "String", "(", "k", ",", "\"iso-8859-1\"", ")", "klower", "=", "k", ".", "lower", "(", ")", ".", "replace", "(", "'_'", ",", "'-'", ")", "bits", "=", "klower", ".", "split", ...
converts things like FOO_BAR to Foo-Bar which is the normal form
[ "converts", "things", "like", "FOO_BAR", "to", "Foo", "-", "Bar", "which", "is", "the", "normal", "form" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/http.py#L50-L55
Jaymon/endpoints
endpoints/http.py
Url.uri
def uri(self): """return the uri, which is everything but base (no scheme, host, etc)""" uristring = self.path if self.query: uristring += "?{}".format(self.query) if self.fragment: uristring += "#{}".format(self.fragment) return uristring
python
def uri(self): """return the uri, which is everything but base (no scheme, host, etc)""" uristring = self.path if self.query: uristring += "?{}".format(self.query) if self.fragment: uristring += "#{}".format(self.fragment) return uristring
[ "def", "uri", "(", "self", ")", ":", "uristring", "=", "self", ".", "path", "if", "self", ".", "query", ":", "uristring", "+=", "\"?{}\"", ".", "format", "(", "self", ".", "query", ")", "if", "self", ".", "fragment", ":", "uristring", "+=", "\"#{}\""...
return the uri, which is everything but base (no scheme, host, etc)
[ "return", "the", "uri", "which", "is", "everything", "but", "base", "(", "no", "scheme", "host", "etc", ")" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/http.py#L271-L279
Jaymon/endpoints
endpoints/http.py
Url.parse_query
def parse_query(cls, query): """return name=val&name2=val2 strings into {name: val} dict""" if not query: return {} d = {} # https://docs.python.org/2/library/urlparse.html for k, kv in urlparse.parse_qs(query, True, strict_parsing=True).items(): #k = k.rstrip("[]") ...
python
def parse_query(cls, query): """return name=val&name2=val2 strings into {name: val} dict""" if not query: return {} d = {} # https://docs.python.org/2/library/urlparse.html for k, kv in urlparse.parse_qs(query, True, strict_parsing=True).items(): #k = k.rstrip("[]") ...
[ "def", "parse_query", "(", "cls", ",", "query", ")", ":", "if", "not", "query", ":", "return", "{", "}", "d", "=", "{", "}", "# https://docs.python.org/2/library/urlparse.html", "for", "k", ",", "kv", "in", "urlparse", ".", "parse_qs", "(", "query", ",", ...
return name=val&name2=val2 strings into {name: val} dict
[ "return", "name", "=", "val&name2", "=", "val2", "strings", "into", "{", "name", ":", "val", "}", "dict" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/http.py#L434-L447
Jaymon/endpoints
endpoints/http.py
Url._normalize_params
def _normalize_params(self, *paths, **query_kwargs): """a lot of the helper methods are very similar, this handles their arguments""" kwargs = {} if paths: fragment = paths[-1] if fragment: if fragment.startswith("#"): kwargs["fragment...
python
def _normalize_params(self, *paths, **query_kwargs): """a lot of the helper methods are very similar, this handles their arguments""" kwargs = {} if paths: fragment = paths[-1] if fragment: if fragment.startswith("#"): kwargs["fragment...
[ "def", "_normalize_params", "(", "self", ",", "*", "paths", ",", "*", "*", "query_kwargs", ")", ":", "kwargs", "=", "{", "}", "if", "paths", ":", "fragment", "=", "paths", "[", "-", "1", "]", "if", "fragment", ":", "if", "fragment", ".", "startswith"...
a lot of the helper methods are very similar, this handles their arguments
[ "a", "lot", "of", "the", "helper", "methods", "are", "very", "similar", "this", "handles", "their", "arguments" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/http.py#L465-L479
Jaymon/endpoints
endpoints/http.py
Url.split_hostname_from_port
def split_hostname_from_port(cls, hostname): """given a hostname:port return a tuple (hostname, port)""" bits = hostname.split(":", 2) p = None d = bits[0] if len(bits) == 2: p = int(bits[1]) return d, p
python
def split_hostname_from_port(cls, hostname): """given a hostname:port return a tuple (hostname, port)""" bits = hostname.split(":", 2) p = None d = bits[0] if len(bits) == 2: p = int(bits[1]) return d, p
[ "def", "split_hostname_from_port", "(", "cls", ",", "hostname", ")", ":", "bits", "=", "hostname", ".", "split", "(", "\":\"", ",", "2", ")", "p", "=", "None", "d", "=", "bits", "[", "0", "]", "if", "len", "(", "bits", ")", "==", "2", ":", "p", ...
given a hostname:port return a tuple (hostname, port)
[ "given", "a", "hostname", ":", "port", "return", "a", "tuple", "(", "hostname", "port", ")" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/http.py#L482-L490
Jaymon/endpoints
endpoints/http.py
Url.add
def add(self, **kwargs): """Just a shortcut to change the current url, equivalent to Url(self, **kwargs)""" if "path" in kwargs: path = kwargs["path"] if isinstance(path, bytes): path = String(path) if not path[0].startswith("/"): paths...
python
def add(self, **kwargs): """Just a shortcut to change the current url, equivalent to Url(self, **kwargs)""" if "path" in kwargs: path = kwargs["path"] if isinstance(path, bytes): path = String(path) if not path[0].startswith("/"): paths...
[ "def", "add", "(", "self", ",", "*", "*", "kwargs", ")", ":", "if", "\"path\"", "in", "kwargs", ":", "path", "=", "kwargs", "[", "\"path\"", "]", "if", "isinstance", "(", "path", ",", "bytes", ")", ":", "path", "=", "String", "(", "path", ")", "i...
Just a shortcut to change the current url, equivalent to Url(self, **kwargs)
[ "Just", "a", "shortcut", "to", "change", "the", "current", "url", "equivalent", "to", "Url", "(", "self", "**", "kwargs", ")" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/http.py#L495-L506
Jaymon/endpoints
endpoints/http.py
Url.controller
def controller(self, *paths, **query_kwargs): """create a new url object using the controller path as a base if you have a controller `foo.BarController` then this would create a new Url instance with `host/foo/bar` as the base path, so any *paths will be appended to `/foo/bar` ...
python
def controller(self, *paths, **query_kwargs): """create a new url object using the controller path as a base if you have a controller `foo.BarController` then this would create a new Url instance with `host/foo/bar` as the base path, so any *paths will be appended to `/foo/bar` ...
[ "def", "controller", "(", "self", ",", "*", "paths", ",", "*", "*", "query_kwargs", ")", ":", "kwargs", "=", "self", ".", "_normalize_params", "(", "*", "paths", ",", "*", "*", "query_kwargs", ")", "if", "self", ".", "controller_path", ":", "if", "\"pa...
create a new url object using the controller path as a base if you have a controller `foo.BarController` then this would create a new Url instance with `host/foo/bar` as the base path, so any *paths will be appended to `/foo/bar` :example: # controller foo.BarController ...
[ "create", "a", "new", "url", "object", "using", "the", "controller", "path", "as", "a", "base" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/http.py#L535-L560
Jaymon/endpoints
endpoints/http.py
Url.base
def base(self, *paths, **query_kwargs): """create a new url object using the current base path as a base if you had requested /foo/bar, then this would append *paths and **query_kwargs to /foo/bar :example: # current path: /foo/bar print url # http://host.com/f...
python
def base(self, *paths, **query_kwargs): """create a new url object using the current base path as a base if you had requested /foo/bar, then this would append *paths and **query_kwargs to /foo/bar :example: # current path: /foo/bar print url # http://host.com/f...
[ "def", "base", "(", "self", ",", "*", "paths", ",", "*", "*", "query_kwargs", ")", ":", "kwargs", "=", "self", ".", "_normalize_params", "(", "*", "paths", ",", "*", "*", "query_kwargs", ")", "if", "self", ".", "path", ":", "if", "\"path\"", "in", ...
create a new url object using the current base path as a base if you had requested /foo/bar, then this would append *paths and **query_kwargs to /foo/bar :example: # current path: /foo/bar print url # http://host.com/foo/bar print url.base() # http://host....
[ "create", "a", "new", "url", "object", "using", "the", "current", "base", "path", "as", "a", "base" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/http.py#L562-L586
Jaymon/endpoints
endpoints/http.py
Url.host
def host(self, *paths, **query_kwargs): """create a new url object using the host as a base if you had requested http://host/foo/bar, then this would append *paths and **query_kwargs to http://host :example: # current url: http://host/foo/bar print url # http:/...
python
def host(self, *paths, **query_kwargs): """create a new url object using the host as a base if you had requested http://host/foo/bar, then this would append *paths and **query_kwargs to http://host :example: # current url: http://host/foo/bar print url # http:/...
[ "def", "host", "(", "self", ",", "*", "paths", ",", "*", "*", "query_kwargs", ")", ":", "kwargs", "=", "self", ".", "_normalize_params", "(", "*", "paths", ",", "*", "*", "query_kwargs", ")", "return", "self", ".", "create", "(", "self", ".", "root",...
create a new url object using the host as a base if you had requested http://host/foo/bar, then this would append *paths and **query_kwargs to http://host :example: # current url: http://host/foo/bar print url # http://host.com/foo/bar print url.host_url()...
[ "create", "a", "new", "url", "object", "using", "the", "host", "as", "a", "base" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/http.py#L588-L606
Jaymon/endpoints
endpoints/http.py
Request.accept_encoding
def accept_encoding(self): """The encoding the client requested the response to use""" # https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Charset ret = "" accept_encoding = self.get_header("Accept-Charset", "") if accept_encoding: bits = re.split(r"\s+...
python
def accept_encoding(self): """The encoding the client requested the response to use""" # https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Charset ret = "" accept_encoding = self.get_header("Accept-Charset", "") if accept_encoding: bits = re.split(r"\s+...
[ "def", "accept_encoding", "(", "self", ")", ":", "# https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Charset", "ret", "=", "\"\"", "accept_encoding", "=", "self", ".", "get_header", "(", "\"Accept-Charset\"", ",", "\"\"", ")", "if", "accept_encoding", ":",...
The encoding the client requested the response to use
[ "The", "encoding", "the", "client", "requested", "the", "response", "to", "use" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/http.py#L816-L825
Jaymon/endpoints
endpoints/http.py
Request.encoding
def encoding(self): """the character encoding of the request, usually only set in POST type requests""" encoding = None ct = self.get_header('content-type') if ct: ah = AcceptHeader(ct) if ah.media_types: encoding = ah.media_types[0][2].get("charse...
python
def encoding(self): """the character encoding of the request, usually only set in POST type requests""" encoding = None ct = self.get_header('content-type') if ct: ah = AcceptHeader(ct) if ah.media_types: encoding = ah.media_types[0][2].get("charse...
[ "def", "encoding", "(", "self", ")", ":", "encoding", "=", "None", "ct", "=", "self", ".", "get_header", "(", "'content-type'", ")", "if", "ct", ":", "ah", "=", "AcceptHeader", "(", "ct", ")", "if", "ah", ".", "media_types", ":", "encoding", "=", "ah...
the character encoding of the request, usually only set in POST type requests
[ "the", "character", "encoding", "of", "the", "request", "usually", "only", "set", "in", "POST", "type", "requests" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/http.py#L828-L837
Jaymon/endpoints
endpoints/http.py
Request.access_token
def access_token(self): """return an Oauth 2.0 Bearer access token if it can be found""" access_token = self.get_auth_bearer() if not access_token: access_token = self.query_kwargs.get('access_token', '') if not access_token: access_token = self.body_kwarg...
python
def access_token(self): """return an Oauth 2.0 Bearer access token if it can be found""" access_token = self.get_auth_bearer() if not access_token: access_token = self.query_kwargs.get('access_token', '') if not access_token: access_token = self.body_kwarg...
[ "def", "access_token", "(", "self", ")", ":", "access_token", "=", "self", ".", "get_auth_bearer", "(", ")", "if", "not", "access_token", ":", "access_token", "=", "self", ".", "query_kwargs", ".", "get", "(", "'access_token'", ",", "''", ")", "if", "not",...
return an Oauth 2.0 Bearer access token if it can be found
[ "return", "an", "Oauth", "2", ".", "0", "Bearer", "access", "token", "if", "it", "can", "be", "found" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/http.py#L840-L848
Jaymon/endpoints
endpoints/http.py
Request.client_tokens
def client_tokens(self): """try and get Oauth 2.0 client id and secret first from basic auth header, then from GET or POST parameters return -- tuple -- client_id, client_secret """ client_id, client_secret = self.get_auth_basic() if not client_id and not client_secret: ...
python
def client_tokens(self): """try and get Oauth 2.0 client id and secret first from basic auth header, then from GET or POST parameters return -- tuple -- client_id, client_secret """ client_id, client_secret = self.get_auth_basic() if not client_id and not client_secret: ...
[ "def", "client_tokens", "(", "self", ")", ":", "client_id", ",", "client_secret", "=", "self", ".", "get_auth_basic", "(", ")", "if", "not", "client_id", "and", "not", "client_secret", ":", "client_id", "=", "self", ".", "query_kwargs", ".", "get", "(", "'...
try and get Oauth 2.0 client id and secret first from basic auth header, then from GET or POST parameters return -- tuple -- client_id, client_secret
[ "try", "and", "get", "Oauth", "2", ".", "0", "client", "id", "and", "secret", "first", "from", "basic", "auth", "header", "then", "from", "GET", "or", "POST", "parameters" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/http.py#L851-L865
Jaymon/endpoints
endpoints/http.py
Request.ips
def ips(self): """return all the possible ips of this request, this will include public and private ips""" r = [] names = ['X_FORWARDED_FOR', 'CLIENT_IP', 'X_REAL_IP', 'X_FORWARDED', 'X_CLUSTER_CLIENT_IP', 'FORWARDED_FOR', 'FORWARDED', 'VIA', 'REMOTE_ADDR'] ...
python
def ips(self): """return all the possible ips of this request, this will include public and private ips""" r = [] names = ['X_FORWARDED_FOR', 'CLIENT_IP', 'X_REAL_IP', 'X_FORWARDED', 'X_CLUSTER_CLIENT_IP', 'FORWARDED_FOR', 'FORWARDED', 'VIA', 'REMOTE_ADDR'] ...
[ "def", "ips", "(", "self", ")", ":", "r", "=", "[", "]", "names", "=", "[", "'X_FORWARDED_FOR'", ",", "'CLIENT_IP'", ",", "'X_REAL_IP'", ",", "'X_FORWARDED'", ",", "'X_CLUSTER_CLIENT_IP'", ",", "'FORWARDED_FOR'", ",", "'FORWARDED'", ",", "'VIA'", ",", "'REMO...
return all the possible ips of this request, this will include public and private ips
[ "return", "all", "the", "possible", "ips", "of", "this", "request", "this", "will", "include", "public", "and", "private", "ips" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/http.py#L868-L884
Jaymon/endpoints
endpoints/http.py
Request.ip
def ip(self): """return the public ip address""" r = '' # this was compiled from here: # https://github.com/un33k/django-ipware # http://www.ietf.org/rfc/rfc3330.txt (IPv4) # http://www.ietf.org/rfc/rfc5156.txt (IPv6) # https://en.wikipedia.org/wiki/Reserved_IP_a...
python
def ip(self): """return the public ip address""" r = '' # this was compiled from here: # https://github.com/un33k/django-ipware # http://www.ietf.org/rfc/rfc3330.txt (IPv4) # http://www.ietf.org/rfc/rfc5156.txt (IPv6) # https://en.wikipedia.org/wiki/Reserved_IP_a...
[ "def", "ip", "(", "self", ")", ":", "r", "=", "''", "# this was compiled from here:", "# https://github.com/un33k/django-ipware", "# http://www.ietf.org/rfc/rfc3330.txt (IPv4)", "# http://www.ietf.org/rfc/rfc5156.txt (IPv6)", "# https://en.wikipedia.org/wiki/Reserved_IP_addresses", "form...
return the public ip address
[ "return", "the", "public", "ip", "address" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/http.py#L887-L919
Jaymon/endpoints
endpoints/http.py
Request.url
def url(self): """return the full request url as an Url() instance""" scheme = self.scheme host = self.host path = self.path query = self.query port = self.port # normalize the port host_domain, host_port = Url.split_hostname_from_port(host) if ho...
python
def url(self): """return the full request url as an Url() instance""" scheme = self.scheme host = self.host path = self.path query = self.query port = self.port # normalize the port host_domain, host_port = Url.split_hostname_from_port(host) if ho...
[ "def", "url", "(", "self", ")", ":", "scheme", "=", "self", ".", "scheme", "host", "=", "self", ".", "host", "path", "=", "self", ".", "path", "query", "=", "self", ".", "query", "port", "=", "self", ".", "port", "# normalize the port", "host_domain", ...
return the full request url as an Url() instance
[ "return", "the", "full", "request", "url", "as", "an", "Url", "()", "instance" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/http.py#L943-L968
Jaymon/endpoints
endpoints/http.py
Request.path
def path(self): """path part of a url (eg, http://host.com/path?query=string)""" self._path = '' path_args = self.path_args path = "/{}".format("/".join(path_args)) return path
python
def path(self): """path part of a url (eg, http://host.com/path?query=string)""" self._path = '' path_args = self.path_args path = "/{}".format("/".join(path_args)) return path
[ "def", "path", "(", "self", ")", ":", "self", ".", "_path", "=", "''", "path_args", "=", "self", ".", "path_args", "path", "=", "\"/{}\"", ".", "format", "(", "\"/\"", ".", "join", "(", "path_args", ")", ")", "return", "path" ]
path part of a url (eg, http://host.com/path?query=string)
[ "path", "part", "of", "a", "url", "(", "eg", "http", ":", "//", "host", ".", "com", "/", "path?query", "=", "string", ")" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/http.py#L971-L976
Jaymon/endpoints
endpoints/http.py
Request.path_args
def path_args(self): """the path converted to list (eg /foo/bar becomes [foo, bar])""" self._path_args = [] path = self.path path_args = list(filter(None, path.split('/'))) return path_args
python
def path_args(self): """the path converted to list (eg /foo/bar becomes [foo, bar])""" self._path_args = [] path = self.path path_args = list(filter(None, path.split('/'))) return path_args
[ "def", "path_args", "(", "self", ")", ":", "self", ".", "_path_args", "=", "[", "]", "path", "=", "self", ".", "path", "path_args", "=", "list", "(", "filter", "(", "None", ",", "path", ".", "split", "(", "'/'", ")", ")", ")", "return", "path_args"...
the path converted to list (eg /foo/bar becomes [foo, bar])
[ "the", "path", "converted", "to", "list", "(", "eg", "/", "foo", "/", "bar", "becomes", "[", "foo", "bar", "]", ")" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/http.py#L979-L984
Jaymon/endpoints
endpoints/http.py
Request.query
def query(self): """query_string part of a url (eg, http://host.com/path?query=string)""" self._query = query = "" query_kwargs = self.query_kwargs if query_kwargs: query = urlencode(query_kwargs, doseq=True) return query
python
def query(self): """query_string part of a url (eg, http://host.com/path?query=string)""" self._query = query = "" query_kwargs = self.query_kwargs if query_kwargs: query = urlencode(query_kwargs, doseq=True) return query
[ "def", "query", "(", "self", ")", ":", "self", ".", "_query", "=", "query", "=", "\"\"", "query_kwargs", "=", "self", ".", "query_kwargs", "if", "query_kwargs", ":", "query", "=", "urlencode", "(", "query_kwargs", ",", "doseq", "=", "True", ")", "return"...
query_string part of a url (eg, http://host.com/path?query=string)
[ "query_string", "part", "of", "a", "url", "(", "eg", "http", ":", "//", "host", ".", "com", "/", "path?query", "=", "string", ")" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/http.py#L987-L993
Jaymon/endpoints
endpoints/http.py
Request.query_kwargs
def query_kwargs(self): """{foo: bar, baz: che}""" self._query_kwargs = query_kwargs = {} query = self.query if query: query_kwargs = self._parse_query_str(query) return query_kwargs
python
def query_kwargs(self): """{foo: bar, baz: che}""" self._query_kwargs = query_kwargs = {} query = self.query if query: query_kwargs = self._parse_query_str(query) return query_kwargs
[ "def", "query_kwargs", "(", "self", ")", ":", "self", ".", "_query_kwargs", "=", "query_kwargs", "=", "{", "}", "query", "=", "self", ".", "query", "if", "query", ":", "query_kwargs", "=", "self", ".", "_parse_query_str", "(", "query", ")", "return", "qu...
{foo: bar, baz: che}
[ "{", "foo", ":", "bar", "baz", ":", "che", "}" ]
train
https://github.com/Jaymon/endpoints/blob/2f1c4ae2c69a168e69447d3d8395ada7becaa5fb/endpoints/http.py#L996-L1001