partition stringclasses 3
values | func_name stringlengths 1 134 | docstring stringlengths 1 46.9k | path stringlengths 4 223 | original_string stringlengths 75 104k | code stringlengths 75 104k | docstring_tokens listlengths 1 1.97k | repo stringlengths 7 55 | language stringclasses 1
value | url stringlengths 87 315 | code_tokens listlengths 19 28.4k | sha stringlengths 40 40 |
|---|---|---|---|---|---|---|---|---|---|---|---|
valid | RBAC.has_permission | Return does the current user can access the resource.
Example::
@app.route('/some_url', methods=['GET', 'POST'])
@rbac.allow(['anonymous'], ['GET'])
def a_view_func():
return Response('Blah Blah...')
If you are not logged.
`rbac.has_permissi... | flask_rbac/__init__.py | def has_permission(self, method, endpoint, user=None):
"""Return does the current user can access the resource.
Example::
@app.route('/some_url', methods=['GET', 'POST'])
@rbac.allow(['anonymous'], ['GET'])
def a_view_func():
return Response('Blah Bla... | def has_permission(self, method, endpoint, user=None):
"""Return does the current user can access the resource.
Example::
@app.route('/some_url', methods=['GET', 'POST'])
@rbac.allow(['anonymous'], ['GET'])
def a_view_func():
return Response('Blah Bla... | [
"Return",
"does",
"the",
"current",
"user",
"can",
"access",
"the",
"resource",
".",
"Example",
"::"
] | shonenada/flask-rbac | python | https://github.com/shonenada/flask-rbac/blob/e085121ff11825114e2d6f8419f0b6de6f9ba476/flask_rbac/__init__.py#L233-L257 | [
"def",
"has_permission",
"(",
"self",
",",
"method",
",",
"endpoint",
",",
"user",
"=",
"None",
")",
":",
"app",
"=",
"self",
".",
"get_app",
"(",
")",
"_user",
"=",
"user",
"or",
"self",
".",
"_user_loader",
"(",
")",
"if",
"not",
"hasattr",
"(",
... | e085121ff11825114e2d6f8419f0b6de6f9ba476 |
valid | RBAC.allow | This is a decorator function.
You can allow roles to access the view func with it.
An example::
@app.route('/website/setting', methods=['GET', 'POST'])
@rbac.allow(['administrator', 'super_user'], ['GET', 'POST'])
def website_setting():
return Respo... | flask_rbac/__init__.py | def allow(self, roles, methods, with_children=True):
"""This is a decorator function.
You can allow roles to access the view func with it.
An example::
@app.route('/website/setting', methods=['GET', 'POST'])
@rbac.allow(['administrator', 'super_user'], ['GET', 'POST'])... | def allow(self, roles, methods, with_children=True):
"""This is a decorator function.
You can allow roles to access the view func with it.
An example::
@app.route('/website/setting', methods=['GET', 'POST'])
@rbac.allow(['administrator', 'super_user'], ['GET', 'POST'])... | [
"This",
"is",
"a",
"decorator",
"function",
"."
] | shonenada/flask-rbac | python | https://github.com/shonenada/flask-rbac/blob/e085121ff11825114e2d6f8419f0b6de6f9ba476/flask_rbac/__init__.py#L259-L286 | [
"def",
"allow",
"(",
"self",
",",
"roles",
",",
"methods",
",",
"with_children",
"=",
"True",
")",
":",
"def",
"decorator",
"(",
"view_func",
")",
":",
"_methods",
"=",
"[",
"m",
".",
"upper",
"(",
")",
"for",
"m",
"in",
"methods",
"]",
"for",
"r",... | e085121ff11825114e2d6f8419f0b6de6f9ba476 |
valid | remove_binaries | Remove all binary files in the adslib directory. | setup.py | def remove_binaries():
"""Remove all binary files in the adslib directory."""
patterns = (
"adslib/*.a",
"adslib/*.o",
"adslib/obj/*.o",
"adslib/*.bin",
"adslib/*.so",
)
for f in functools.reduce(operator.iconcat, [glob.glob(p) for p in patterns]):
... | def remove_binaries():
"""Remove all binary files in the adslib directory."""
patterns = (
"adslib/*.a",
"adslib/*.o",
"adslib/obj/*.o",
"adslib/*.bin",
"adslib/*.so",
)
for f in functools.reduce(operator.iconcat, [glob.glob(p) for p in patterns]):
... | [
"Remove",
"all",
"binary",
"files",
"in",
"the",
"adslib",
"directory",
"."
] | stlehmann/pyads | python | https://github.com/stlehmann/pyads/blob/44bd84394db2785332ac44b2948373916bea0f02/setup.py#L60-L71 | [
"def",
"remove_binaries",
"(",
")",
":",
"patterns",
"=",
"(",
"\"adslib/*.a\"",
",",
"\"adslib/*.o\"",
",",
"\"adslib/obj/*.o\"",
",",
"\"adslib/*.bin\"",
",",
"\"adslib/*.so\"",
",",
")",
"for",
"f",
"in",
"functools",
".",
"reduce",
"(",
"operator",
".",
"i... | 44bd84394db2785332ac44b2948373916bea0f02 |
valid | router_function | Raise a runtime error if on Win32 systems.
Decorator.
Decorator for functions that interact with the router for the Linux
implementation of the ADS library.
Unlike the Windows implementation which uses a separate router daemon,
the Linux library manages AMS routing in-process. As such, routing mu... | pyads/pyads_ex.py | def router_function(fn):
# type: (Callable) -> Callable
"""Raise a runtime error if on Win32 systems.
Decorator.
Decorator for functions that interact with the router for the Linux
implementation of the ADS library.
Unlike the Windows implementation which uses a separate router daemon,
th... | def router_function(fn):
# type: (Callable) -> Callable
"""Raise a runtime error if on Win32 systems.
Decorator.
Decorator for functions that interact with the router for the Linux
implementation of the ADS library.
Unlike the Windows implementation which uses a separate router daemon,
th... | [
"Raise",
"a",
"runtime",
"error",
"if",
"on",
"Win32",
"systems",
"."
] | stlehmann/pyads | python | https://github.com/stlehmann/pyads/blob/44bd84394db2785332ac44b2948373916bea0f02/pyads/pyads_ex.py#L103-L129 | [
"def",
"router_function",
"(",
"fn",
")",
":",
"# type: (Callable) -> Callable",
"@",
"wraps",
"(",
"fn",
")",
"def",
"wrapper",
"(",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"# type: (Any, Any) -> Callable",
"if",
"platform_is_windows",
"(",
")",
":",
... | 44bd84394db2785332ac44b2948373916bea0f02 |
valid | adsAddRoute | Establish a new route in the AMS Router.
:param pyads.structs.SAmsNetId net_id: net id of routing endpoint
:param str ip_address: ip address of the routing endpoint | pyads/pyads_ex.py | def adsAddRoute(net_id, ip_address):
# type: (SAmsNetId, str) -> None
"""Establish a new route in the AMS Router.
:param pyads.structs.SAmsNetId net_id: net id of routing endpoint
:param str ip_address: ip address of the routing endpoint
"""
add_route = _adsDLL.AdsAddRoute
add_route.restyp... | def adsAddRoute(net_id, ip_address):
# type: (SAmsNetId, str) -> None
"""Establish a new route in the AMS Router.
:param pyads.structs.SAmsNetId net_id: net id of routing endpoint
:param str ip_address: ip address of the routing endpoint
"""
add_route = _adsDLL.AdsAddRoute
add_route.restyp... | [
"Establish",
"a",
"new",
"route",
"in",
"the",
"AMS",
"Router",
"."
] | stlehmann/pyads | python | https://github.com/stlehmann/pyads/blob/44bd84394db2785332ac44b2948373916bea0f02/pyads/pyads_ex.py#L133-L150 | [
"def",
"adsAddRoute",
"(",
"net_id",
",",
"ip_address",
")",
":",
"# type: (SAmsNetId, str) -> None",
"add_route",
"=",
"_adsDLL",
".",
"AdsAddRoute",
"add_route",
".",
"restype",
"=",
"ctypes",
".",
"c_long",
"# Convert ip address to bytes (PY3) and get pointer.",
"ip_ad... | 44bd84394db2785332ac44b2948373916bea0f02 |
valid | adsPortOpenEx | Connect to the TwinCAT message router.
:rtype: int
:return: port number | pyads/pyads_ex.py | def adsPortOpenEx():
# type: () -> int
"""Connect to the TwinCAT message router.
:rtype: int
:return: port number
"""
port_open_ex = _adsDLL.AdsPortOpenEx
port_open_ex.restype = ctypes.c_long
port = port_open_ex()
if port == 0:
raise RuntimeError("Failed to open port on AM... | def adsPortOpenEx():
# type: () -> int
"""Connect to the TwinCAT message router.
:rtype: int
:return: port number
"""
port_open_ex = _adsDLL.AdsPortOpenEx
port_open_ex.restype = ctypes.c_long
port = port_open_ex()
if port == 0:
raise RuntimeError("Failed to open port on AM... | [
"Connect",
"to",
"the",
"TwinCAT",
"message",
"router",
"."
] | stlehmann/pyads | python | https://github.com/stlehmann/pyads/blob/44bd84394db2785332ac44b2948373916bea0f02/pyads/pyads_ex.py#L166-L181 | [
"def",
"adsPortOpenEx",
"(",
")",
":",
"# type: () -> int",
"port_open_ex",
"=",
"_adsDLL",
".",
"AdsPortOpenEx",
"port_open_ex",
".",
"restype",
"=",
"ctypes",
".",
"c_long",
"port",
"=",
"port_open_ex",
"(",
")",
"if",
"port",
"==",
"0",
":",
"raise",
"Run... | 44bd84394db2785332ac44b2948373916bea0f02 |
valid | adsPortCloseEx | Close the connection to the TwinCAT message router. | pyads/pyads_ex.py | def adsPortCloseEx(port):
# type: (int) -> None
"""Close the connection to the TwinCAT message router."""
port_close_ex = _adsDLL.AdsPortCloseEx
port_close_ex.restype = ctypes.c_long
error_code = port_close_ex(port)
if error_code:
raise ADSError(error_code) | def adsPortCloseEx(port):
# type: (int) -> None
"""Close the connection to the TwinCAT message router."""
port_close_ex = _adsDLL.AdsPortCloseEx
port_close_ex.restype = ctypes.c_long
error_code = port_close_ex(port)
if error_code:
raise ADSError(error_code) | [
"Close",
"the",
"connection",
"to",
"the",
"TwinCAT",
"message",
"router",
"."
] | stlehmann/pyads | python | https://github.com/stlehmann/pyads/blob/44bd84394db2785332ac44b2948373916bea0f02/pyads/pyads_ex.py#L184-L192 | [
"def",
"adsPortCloseEx",
"(",
"port",
")",
":",
"# type: (int) -> None",
"port_close_ex",
"=",
"_adsDLL",
".",
"AdsPortCloseEx",
"port_close_ex",
".",
"restype",
"=",
"ctypes",
".",
"c_long",
"error_code",
"=",
"port_close_ex",
"(",
"port",
")",
"if",
"error_code"... | 44bd84394db2785332ac44b2948373916bea0f02 |
valid | adsGetLocalAddressEx | Return the local AMS-address and the port number.
:rtype: pyads.structs.AmsAddr
:return: AMS-address | pyads/pyads_ex.py | def adsGetLocalAddressEx(port):
# type: (int) -> AmsAddr
"""Return the local AMS-address and the port number.
:rtype: pyads.structs.AmsAddr
:return: AMS-address
"""
get_local_address_ex = _adsDLL.AdsGetLocalAddressEx
ams_address_struct = SAmsAddr()
error_code = get_local_address_ex(por... | def adsGetLocalAddressEx(port):
# type: (int) -> AmsAddr
"""Return the local AMS-address and the port number.
:rtype: pyads.structs.AmsAddr
:return: AMS-address
"""
get_local_address_ex = _adsDLL.AdsGetLocalAddressEx
ams_address_struct = SAmsAddr()
error_code = get_local_address_ex(por... | [
"Return",
"the",
"local",
"AMS",
"-",
"address",
"and",
"the",
"port",
"number",
"."
] | stlehmann/pyads | python | https://github.com/stlehmann/pyads/blob/44bd84394db2785332ac44b2948373916bea0f02/pyads/pyads_ex.py#L195-L213 | [
"def",
"adsGetLocalAddressEx",
"(",
"port",
")",
":",
"# type: (int) -> AmsAddr",
"get_local_address_ex",
"=",
"_adsDLL",
".",
"AdsGetLocalAddressEx",
"ams_address_struct",
"=",
"SAmsAddr",
"(",
")",
"error_code",
"=",
"get_local_address_ex",
"(",
"port",
",",
"ctypes",... | 44bd84394db2785332ac44b2948373916bea0f02 |
valid | adsSyncReadStateReqEx | Read the current ADS-state and the machine-state.
Read the current ADS-state and the machine-state from the
ADS-server.
:param pyads.structs.AmsAddr address: local or remote AmsAddr
:rtype: (int, int)
:return: ads_state, device_state | pyads/pyads_ex.py | def adsSyncReadStateReqEx(port, address):
# type: (int, AmsAddr) -> Tuple[int, int]
"""Read the current ADS-state and the machine-state.
Read the current ADS-state and the machine-state from the
ADS-server.
:param pyads.structs.AmsAddr address: local or remote AmsAddr
:rtype: (int, int)
:r... | def adsSyncReadStateReqEx(port, address):
# type: (int, AmsAddr) -> Tuple[int, int]
"""Read the current ADS-state and the machine-state.
Read the current ADS-state and the machine-state from the
ADS-server.
:param pyads.structs.AmsAddr address: local or remote AmsAddr
:rtype: (int, int)
:r... | [
"Read",
"the",
"current",
"ADS",
"-",
"state",
"and",
"the",
"machine",
"-",
"state",
"."
] | stlehmann/pyads | python | https://github.com/stlehmann/pyads/blob/44bd84394db2785332ac44b2948373916bea0f02/pyads/pyads_ex.py#L228-L260 | [
"def",
"adsSyncReadStateReqEx",
"(",
"port",
",",
"address",
")",
":",
"# type: (int, AmsAddr) -> Tuple[int, int]",
"sync_read_state_request",
"=",
"_adsDLL",
".",
"AdsSyncReadStateReqEx",
"# C pointer to ams address struct",
"ams_address_pointer",
"=",
"ctypes",
".",
"pointer"... | 44bd84394db2785332ac44b2948373916bea0f02 |
valid | adsSyncReadDeviceInfoReqEx | Read the name and the version number of the ADS-server.
:param int port: local AMS port as returned by adsPortOpenEx()
:param pyads.structs.AmsAddr address: local or remote AmsAddr
:rtype: string, AdsVersion
:return: device name, version | pyads/pyads_ex.py | def adsSyncReadDeviceInfoReqEx(port, address):
# type: (int, AmsAddr) -> Tuple[str, AdsVersion]
"""Read the name and the version number of the ADS-server.
:param int port: local AMS port as returned by adsPortOpenEx()
:param pyads.structs.AmsAddr address: local or remote AmsAddr
:rtype: string, Ads... | def adsSyncReadDeviceInfoReqEx(port, address):
# type: (int, AmsAddr) -> Tuple[str, AdsVersion]
"""Read the name and the version number of the ADS-server.
:param int port: local AMS port as returned by adsPortOpenEx()
:param pyads.structs.AmsAddr address: local or remote AmsAddr
:rtype: string, Ads... | [
"Read",
"the",
"name",
"and",
"the",
"version",
"number",
"of",
"the",
"ADS",
"-",
"server",
"."
] | stlehmann/pyads | python | https://github.com/stlehmann/pyads/blob/44bd84394db2785332ac44b2948373916bea0f02/pyads/pyads_ex.py#L263-L293 | [
"def",
"adsSyncReadDeviceInfoReqEx",
"(",
"port",
",",
"address",
")",
":",
"# type: (int, AmsAddr) -> Tuple[str, AdsVersion]",
"sync_read_device_info_request",
"=",
"_adsDLL",
".",
"AdsSyncReadDeviceInfoReqEx",
"# Get pointer to the target AMS address",
"ams_address_pointer",
"=",
... | 44bd84394db2785332ac44b2948373916bea0f02 |
valid | adsSyncWriteControlReqEx | Change the ADS state and the machine-state of the ADS-server.
:param int port: local AMS port as returned by adsPortOpenEx()
:param pyads.structs.AmsAddr adr: local or remote AmsAddr
:param int ads_state: new ADS-state, according to ADSTATE constants
:param int device_state: new machine-state
:para... | pyads/pyads_ex.py | def adsSyncWriteControlReqEx(
port, address, ads_state, device_state, data, plc_data_type
):
# type: (int, AmsAddr, int, int, Any, Type) -> None
"""Change the ADS state and the machine-state of the ADS-server.
:param int port: local AMS port as returned by adsPortOpenEx()
:param pyads.structs.AmsAd... | def adsSyncWriteControlReqEx(
port, address, ads_state, device_state, data, plc_data_type
):
# type: (int, AmsAddr, int, int, Any, Type) -> None
"""Change the ADS state and the machine-state of the ADS-server.
:param int port: local AMS port as returned by adsPortOpenEx()
:param pyads.structs.AmsAd... | [
"Change",
"the",
"ADS",
"state",
"and",
"the",
"machine",
"-",
"state",
"of",
"the",
"ADS",
"-",
"server",
"."
] | stlehmann/pyads | python | https://github.com/stlehmann/pyads/blob/44bd84394db2785332ac44b2948373916bea0f02/pyads/pyads_ex.py#L296-L335 | [
"def",
"adsSyncWriteControlReqEx",
"(",
"port",
",",
"address",
",",
"ads_state",
",",
"device_state",
",",
"data",
",",
"plc_data_type",
")",
":",
"# type: (int, AmsAddr, int, int, Any, Type) -> None",
"sync_write_control_request",
"=",
"_adsDLL",
".",
"AdsSyncWriteControl... | 44bd84394db2785332ac44b2948373916bea0f02 |
valid | adsSyncWriteReqEx | Send data synchronous to an ADS-device.
:param int port: local AMS port as returned by adsPortOpenEx()
:param pyads.structs.AmsAddr address: local or remote AmsAddr
:param int indexGroup: PLC storage area, according to the INDEXGROUP
constants
:param int index_offset: PLC storage address
:p... | pyads/pyads_ex.py | def adsSyncWriteReqEx(port, address, index_group, index_offset, value, plc_data_type):
# type: (int, AmsAddr, int, int, Any, Type) -> None
"""Send data synchronous to an ADS-device.
:param int port: local AMS port as returned by adsPortOpenEx()
:param pyads.structs.AmsAddr address: local or remote AmsA... | def adsSyncWriteReqEx(port, address, index_group, index_offset, value, plc_data_type):
# type: (int, AmsAddr, int, int, Any, Type) -> None
"""Send data synchronous to an ADS-device.
:param int port: local AMS port as returned by adsPortOpenEx()
:param pyads.structs.AmsAddr address: local or remote AmsA... | [
"Send",
"data",
"synchronous",
"to",
"an",
"ADS",
"-",
"device",
"."
] | stlehmann/pyads | python | https://github.com/stlehmann/pyads/blob/44bd84394db2785332ac44b2948373916bea0f02/pyads/pyads_ex.py#L338-L382 | [
"def",
"adsSyncWriteReqEx",
"(",
"port",
",",
"address",
",",
"index_group",
",",
"index_offset",
",",
"value",
",",
"plc_data_type",
")",
":",
"# type: (int, AmsAddr, int, int, Any, Type) -> None",
"sync_write_request",
"=",
"_adsDLL",
".",
"AdsSyncWriteReqEx",
"ams_addr... | 44bd84394db2785332ac44b2948373916bea0f02 |
valid | adsSyncReadWriteReqEx2 | Read and write data synchronous from/to an ADS-device.
:param int port: local AMS port as returned by adsPortOpenEx()
:param pyads.structs.AmsAddr address: local or remote AmsAddr
:param int index_group: PLC storage area, according to the INDEXGROUP
constants
:param int index_offset: PLC storag... | pyads/pyads_ex.py | def adsSyncReadWriteReqEx2(
port,
address,
index_group,
index_offset,
read_data_type,
value,
write_data_type,
return_ctypes=False,
):
# type: (int, AmsAddr, int, int, Type, Any, Type, bool) -> Any
"""Read and write data synchronous from/to an ADS-device.
:param int port: loc... | def adsSyncReadWriteReqEx2(
port,
address,
index_group,
index_offset,
read_data_type,
value,
write_data_type,
return_ctypes=False,
):
# type: (int, AmsAddr, int, int, Type, Any, Type, bool) -> Any
"""Read and write data synchronous from/to an ADS-device.
:param int port: loc... | [
"Read",
"and",
"write",
"data",
"synchronous",
"from",
"/",
"to",
"an",
"ADS",
"-",
"device",
"."
] | stlehmann/pyads | python | https://github.com/stlehmann/pyads/blob/44bd84394db2785332ac44b2948373916bea0f02/pyads/pyads_ex.py#L385-L482 | [
"def",
"adsSyncReadWriteReqEx2",
"(",
"port",
",",
"address",
",",
"index_group",
",",
"index_offset",
",",
"read_data_type",
",",
"value",
",",
"write_data_type",
",",
"return_ctypes",
"=",
"False",
",",
")",
":",
"# type: (int, AmsAddr, int, int, Type, Any, Type, bool... | 44bd84394db2785332ac44b2948373916bea0f02 |
valid | adsSyncReadReqEx2 | Read data synchronous from an ADS-device.
:param int port: local AMS port as returned by adsPortOpenEx()
:param pyads.structs.AmsAddr address: local or remote AmsAddr
:param int index_group: PLC storage area, according to the INDEXGROUP
constants
:param int index_offset: PLC storage address
... | pyads/pyads_ex.py | def adsSyncReadReqEx2(
port, address, index_group, index_offset, data_type, return_ctypes=False
):
# type: (int, AmsAddr, int, int, Type, bool) -> Any
"""Read data synchronous from an ADS-device.
:param int port: local AMS port as returned by adsPortOpenEx()
:param pyads.structs.AmsAddr address: lo... | def adsSyncReadReqEx2(
port, address, index_group, index_offset, data_type, return_ctypes=False
):
# type: (int, AmsAddr, int, int, Type, bool) -> Any
"""Read data synchronous from an ADS-device.
:param int port: local AMS port as returned by adsPortOpenEx()
:param pyads.structs.AmsAddr address: lo... | [
"Read",
"data",
"synchronous",
"from",
"an",
"ADS",
"-",
"device",
"."
] | stlehmann/pyads | python | https://github.com/stlehmann/pyads/blob/44bd84394db2785332ac44b2948373916bea0f02/pyads/pyads_ex.py#L485-L555 | [
"def",
"adsSyncReadReqEx2",
"(",
"port",
",",
"address",
",",
"index_group",
",",
"index_offset",
",",
"data_type",
",",
"return_ctypes",
"=",
"False",
")",
":",
"# type: (int, AmsAddr, int, int, Type, bool) -> Any",
"sync_read_request",
"=",
"_adsDLL",
".",
"AdsSyncRea... | 44bd84394db2785332ac44b2948373916bea0f02 |
valid | adsSyncReadByNameEx | Read data synchronous from an ADS-device from data name.
:param int port: local AMS port as returned by adsPortOpenEx()
:param pyads.structs.AmsAddr address: local or remote AmsAddr
:param string data_name: data name
:param Type data_type: type of the data given to the PLC, according to
PLCTYPE... | pyads/pyads_ex.py | def adsSyncReadByNameEx(port, address, data_name, data_type, return_ctypes=False):
# type: (int, AmsAddr, str, Type, bool) -> Any
"""Read data synchronous from an ADS-device from data name.
:param int port: local AMS port as returned by adsPortOpenEx()
:param pyads.structs.AmsAddr address: local or rem... | def adsSyncReadByNameEx(port, address, data_name, data_type, return_ctypes=False):
# type: (int, AmsAddr, str, Type, bool) -> Any
"""Read data synchronous from an ADS-device from data name.
:param int port: local AMS port as returned by adsPortOpenEx()
:param pyads.structs.AmsAddr address: local or rem... | [
"Read",
"data",
"synchronous",
"from",
"an",
"ADS",
"-",
"device",
"from",
"data",
"name",
"."
] | stlehmann/pyads | python | https://github.com/stlehmann/pyads/blob/44bd84394db2785332ac44b2948373916bea0f02/pyads/pyads_ex.py#L558-L592 | [
"def",
"adsSyncReadByNameEx",
"(",
"port",
",",
"address",
",",
"data_name",
",",
"data_type",
",",
"return_ctypes",
"=",
"False",
")",
":",
"# type: (int, AmsAddr, str, Type, bool) -> Any",
"# Get the handle of the PLC-variable",
"handle",
"=",
"adsSyncReadWriteReqEx2",
"(... | 44bd84394db2785332ac44b2948373916bea0f02 |
valid | adsSyncWriteByNameEx | Send data synchronous to an ADS-device from data name.
:param int port: local AMS port as returned by adsPortOpenEx()
:param pyads.structs.AmsAddr address: local or remote AmsAddr
:param string data_name: PLC storage address
:param value: value to write to the storage address of the PLC
:param Type... | pyads/pyads_ex.py | def adsSyncWriteByNameEx(port, address, data_name, value, data_type):
# type: (int, AmsAddr, str, Any, Type) -> None
"""Send data synchronous to an ADS-device from data name.
:param int port: local AMS port as returned by adsPortOpenEx()
:param pyads.structs.AmsAddr address: local or remote AmsAddr
... | def adsSyncWriteByNameEx(port, address, data_name, value, data_type):
# type: (int, AmsAddr, str, Any, Type) -> None
"""Send data synchronous to an ADS-device from data name.
:param int port: local AMS port as returned by adsPortOpenEx()
:param pyads.structs.AmsAddr address: local or remote AmsAddr
... | [
"Send",
"data",
"synchronous",
"to",
"an",
"ADS",
"-",
"device",
"from",
"data",
"name",
"."
] | stlehmann/pyads | python | https://github.com/stlehmann/pyads/blob/44bd84394db2785332ac44b2948373916bea0f02/pyads/pyads_ex.py#L595-L622 | [
"def",
"adsSyncWriteByNameEx",
"(",
"port",
",",
"address",
",",
"data_name",
",",
"value",
",",
"data_type",
")",
":",
"# type: (int, AmsAddr, str, Any, Type) -> None",
"# Get the handle of the PLC-variable",
"handle",
"=",
"adsSyncReadWriteReqEx2",
"(",
"port",
",",
"ad... | 44bd84394db2785332ac44b2948373916bea0f02 |
valid | adsSyncAddDeviceNotificationReqEx | Add a device notification.
:param int port: local AMS port as returned by adsPortOpenEx()
:param pyads.structs.AmsAddr adr: local or remote AmsAddr
:param string data_name: PLC storage address
:param pyads.structs.NotificationAttrib pNoteAttrib: notification attributes
:param callback: Callback fun... | pyads/pyads_ex.py | def adsSyncAddDeviceNotificationReqEx(
port, adr, data_name, pNoteAttrib, callback, user_handle=None
):
# type: (int, AmsAddr, str, NotificationAttrib, Callable, int) -> Tuple[int, int]
"""Add a device notification.
:param int port: local AMS port as returned by adsPortOpenEx()
:param pyads.structs... | def adsSyncAddDeviceNotificationReqEx(
port, adr, data_name, pNoteAttrib, callback, user_handle=None
):
# type: (int, AmsAddr, str, NotificationAttrib, Callable, int) -> Tuple[int, int]
"""Add a device notification.
:param int port: local AMS port as returned by adsPortOpenEx()
:param pyads.structs... | [
"Add",
"a",
"device",
"notification",
"."
] | stlehmann/pyads | python | https://github.com/stlehmann/pyads/blob/44bd84394db2785332ac44b2948373916bea0f02/pyads/pyads_ex.py#L625-L693 | [
"def",
"adsSyncAddDeviceNotificationReqEx",
"(",
"port",
",",
"adr",
",",
"data_name",
",",
"pNoteAttrib",
",",
"callback",
",",
"user_handle",
"=",
"None",
")",
":",
"# type: (int, AmsAddr, str, NotificationAttrib, Callable, int) -> Tuple[int, int]",
"global",
"callback_stor... | 44bd84394db2785332ac44b2948373916bea0f02 |
valid | adsSyncDelDeviceNotificationReqEx | Remove a device notification.
:param int port: local AMS port as returned by adsPortOpenEx()
:param pyads.structs.AmsAddr adr: local or remote AmsAddr
:param int notification_handle: Notification Handle
:param int user_handle: User Handle | pyads/pyads_ex.py | def adsSyncDelDeviceNotificationReqEx(port, adr, notification_handle, user_handle):
# type: (int, AmsAddr, int, int) -> None
"""Remove a device notification.
:param int port: local AMS port as returned by adsPortOpenEx()
:param pyads.structs.AmsAddr adr: local or remote AmsAddr
:param int notificat... | def adsSyncDelDeviceNotificationReqEx(port, adr, notification_handle, user_handle):
# type: (int, AmsAddr, int, int) -> None
"""Remove a device notification.
:param int port: local AMS port as returned by adsPortOpenEx()
:param pyads.structs.AmsAddr adr: local or remote AmsAddr
:param int notificat... | [
"Remove",
"a",
"device",
"notification",
"."
] | stlehmann/pyads | python | https://github.com/stlehmann/pyads/blob/44bd84394db2785332ac44b2948373916bea0f02/pyads/pyads_ex.py#L696-L715 | [
"def",
"adsSyncDelDeviceNotificationReqEx",
"(",
"port",
",",
"adr",
",",
"notification_handle",
",",
"user_handle",
")",
":",
"# type: (int, AmsAddr, int, int) -> None",
"adsSyncDelDeviceNotificationReqFct",
"=",
"_adsDLL",
".",
"AdsSyncDelDeviceNotificationReqEx",
"pAmsAddr",
... | 44bd84394db2785332ac44b2948373916bea0f02 |
valid | adsSyncSetTimeoutEx | Set Timeout.
:param int port: local AMS port as returned by adsPortOpenEx()
:param int nMs: timeout in ms | pyads/pyads_ex.py | def adsSyncSetTimeoutEx(port, nMs):
# type: (int, int) -> None
"""Set Timeout.
:param int port: local AMS port as returned by adsPortOpenEx()
:param int nMs: timeout in ms
"""
adsSyncSetTimeoutFct = _adsDLL.AdsSyncSetTimeoutEx
cms = ctypes.c_long(nMs)
err_code = adsSyncSetTimeoutFct(po... | def adsSyncSetTimeoutEx(port, nMs):
# type: (int, int) -> None
"""Set Timeout.
:param int port: local AMS port as returned by adsPortOpenEx()
:param int nMs: timeout in ms
"""
adsSyncSetTimeoutFct = _adsDLL.AdsSyncSetTimeoutEx
cms = ctypes.c_long(nMs)
err_code = adsSyncSetTimeoutFct(po... | [
"Set",
"Timeout",
"."
] | stlehmann/pyads | python | https://github.com/stlehmann/pyads/blob/44bd84394db2785332ac44b2948373916bea0f02/pyads/pyads_ex.py#L718-L730 | [
"def",
"adsSyncSetTimeoutEx",
"(",
"port",
",",
"nMs",
")",
":",
"# type: (int, int) -> None",
"adsSyncSetTimeoutFct",
"=",
"_adsDLL",
".",
"AdsSyncSetTimeoutEx",
"cms",
"=",
"ctypes",
".",
"c_long",
"(",
"nMs",
")",
"err_code",
"=",
"adsSyncSetTimeoutFct",
"(",
"... | 44bd84394db2785332ac44b2948373916bea0f02 |
valid | _parse_ams_netid | Parse an AmsNetId from *str* to *SAmsNetId*.
:param str ams_netid: NetId as a string
:rtype: SAmsNetId
:return: NetId as a struct | pyads/ads.py | def _parse_ams_netid(ams_netid):
# type: (str) -> SAmsNetId
"""Parse an AmsNetId from *str* to *SAmsNetId*.
:param str ams_netid: NetId as a string
:rtype: SAmsNetId
:return: NetId as a struct
"""
try:
id_numbers = list(map(int, ams_netid.split(".")))
except ValueErr... | def _parse_ams_netid(ams_netid):
# type: (str) -> SAmsNetId
"""Parse an AmsNetId from *str* to *SAmsNetId*.
:param str ams_netid: NetId as a string
:rtype: SAmsNetId
:return: NetId as a struct
"""
try:
id_numbers = list(map(int, ams_netid.split(".")))
except ValueErr... | [
"Parse",
"an",
"AmsNetId",
"from",
"*",
"str",
"*",
"to",
"*",
"SAmsNetId",
"*",
".",
":",
"param",
"str",
"ams_netid",
":",
"NetId",
"as",
"a",
"string",
":",
"rtype",
":",
"SAmsNetId",
":",
"return",
":",
"NetId",
"as",
"a",
"struct"
] | stlehmann/pyads | python | https://github.com/stlehmann/pyads/blob/44bd84394db2785332ac44b2948373916bea0f02/pyads/ads.py#L66-L86 | [
"def",
"_parse_ams_netid",
"(",
"ams_netid",
")",
":",
"# type: (str) -> SAmsNetId\r",
"try",
":",
"id_numbers",
"=",
"list",
"(",
"map",
"(",
"int",
",",
"ams_netid",
".",
"split",
"(",
"\".\"",
")",
")",
")",
"except",
"ValueError",
":",
"raise",
"ValueErr... | 44bd84394db2785332ac44b2948373916bea0f02 |
valid | set_local_address | Set the local NetID (**Linux only**).
:param str: new AmsNetID
:rtype: None
**Usage:**
>>> import pyads
>>> pyads.open_port()
>>> pyads.set_local_address('0.0.0.0.1.1') | pyads/ads.py | def set_local_address(ams_netid):
# type: (Union[str, SAmsNetId]) -> None
"""Set the local NetID (**Linux only**).
:param str: new AmsNetID
:rtype: None
**Usage:**
>>> import pyads
>>> pyads.open_port()
>>> pyads.set_local_address('0.0.0.0.1.1')
"""
... | def set_local_address(ams_netid):
# type: (Union[str, SAmsNetId]) -> None
"""Set the local NetID (**Linux only**).
:param str: new AmsNetID
:rtype: None
**Usage:**
>>> import pyads
>>> pyads.open_port()
>>> pyads.set_local_address('0.0.0.0.1.1')
"""
... | [
"Set",
"the",
"local",
"NetID",
"(",
"**",
"Linux",
"only",
"**",
")",
".",
":",
"param",
"str",
":",
"new",
"AmsNetID",
":",
"rtype",
":",
"None",
"**",
"Usage",
":",
"**",
">>>",
"import",
"pyads",
">>>",
"pyads",
".",
"open_port",
"()",
">>>",
"... | stlehmann/pyads | python | https://github.com/stlehmann/pyads/blob/44bd84394db2785332ac44b2948373916bea0f02/pyads/ads.py#L126-L152 | [
"def",
"set_local_address",
"(",
"ams_netid",
")",
":",
"# type: (Union[str, SAmsNetId]) -> None\r",
"if",
"isinstance",
"(",
"ams_netid",
",",
"str",
")",
":",
"ams_netid_st",
"=",
"_parse_ams_netid",
"(",
"ams_netid",
")",
"else",
":",
"ams_netid_st",
"=",
"ams_ne... | 44bd84394db2785332ac44b2948373916bea0f02 |
valid | write_control | Change the ADS state and the machine-state of the ADS-server.
:param AmsAddr adr: local or remote AmsAddr
:param int ads_state: new ADS-state, according to ADSTATE constants
:param int device_state: new machine-state
:param data: additional data
:param int plc_datatype: datatype, according to... | pyads/ads.py | def write_control(adr, ads_state, device_state, data, plc_datatype):
# type: (AmsAddr, int, int, Any, Type) -> None
"""Change the ADS state and the machine-state of the ADS-server.
:param AmsAddr adr: local or remote AmsAddr
:param int ads_state: new ADS-state, according to ADSTATE constants
... | def write_control(adr, ads_state, device_state, data, plc_datatype):
# type: (AmsAddr, int, int, Any, Type) -> None
"""Change the ADS state and the machine-state of the ADS-server.
:param AmsAddr adr: local or remote AmsAddr
:param int ads_state: new ADS-state, according to ADSTATE constants
... | [
"Change",
"the",
"ADS",
"state",
"and",
"the",
"machine",
"-",
"state",
"of",
"the",
"ADS",
"-",
"server",
".",
":",
"param",
"AmsAddr",
"adr",
":",
"local",
"or",
"remote",
"AmsAddr",
":",
"param",
"int",
"ads_state",
":",
"new",
"ADS",
"-",
"state",
... | stlehmann/pyads | python | https://github.com/stlehmann/pyads/blob/44bd84394db2785332ac44b2948373916bea0f02/pyads/ads.py#L173-L196 | [
"def",
"write_control",
"(",
"adr",
",",
"ads_state",
",",
"device_state",
",",
"data",
",",
"plc_datatype",
")",
":",
"# type: (AmsAddr, int, int, Any, Type) -> None\r",
"if",
"port",
"is",
"not",
"None",
":",
"return",
"adsSyncWriteControlReqEx",
"(",
"port",
",",... | 44bd84394db2785332ac44b2948373916bea0f02 |
valid | write | Send data synchronous to an ADS-device.
:param AmsAddr adr: local or remote AmsAddr
:param int index_group: PLC storage area, according to the INDEXGROUP
constants
:param int index_offset: PLC storage address
:param value: value to write to the storage address of the PLC
:param Type ... | pyads/ads.py | def write(adr, index_group, index_offset, value, plc_datatype):
# type: (AmsAddr, int, int, Any, Type) -> None
"""Send data synchronous to an ADS-device.
:param AmsAddr adr: local or remote AmsAddr
:param int index_group: PLC storage area, according to the INDEXGROUP
constants
:param... | def write(adr, index_group, index_offset, value, plc_datatype):
# type: (AmsAddr, int, int, Any, Type) -> None
"""Send data synchronous to an ADS-device.
:param AmsAddr adr: local or remote AmsAddr
:param int index_group: PLC storage area, according to the INDEXGROUP
constants
:param... | [
"Send",
"data",
"synchronous",
"to",
"an",
"ADS",
"-",
"device",
".",
":",
"param",
"AmsAddr",
"adr",
":",
"local",
"or",
"remote",
"AmsAddr",
":",
"param",
"int",
"index_group",
":",
"PLC",
"storage",
"area",
"according",
"to",
"the",
"INDEXGROUP",
"const... | stlehmann/pyads | python | https://github.com/stlehmann/pyads/blob/44bd84394db2785332ac44b2948373916bea0f02/pyads/ads.py#L214-L230 | [
"def",
"write",
"(",
"adr",
",",
"index_group",
",",
"index_offset",
",",
"value",
",",
"plc_datatype",
")",
":",
"# type: (AmsAddr, int, int, Any, Type) -> None\r",
"if",
"port",
"is",
"not",
"None",
":",
"return",
"adsSyncWriteReqEx",
"(",
"port",
",",
"adr",
... | 44bd84394db2785332ac44b2948373916bea0f02 |
valid | read_write | Read and write data synchronous from/to an ADS-device.
:param AmsAddr adr: local or remote AmsAddr
:param int index_group: PLC storage area, according to the INDEXGROUP
constants
:param int index_offset: PLC storage address
:param Type plc_read_datatype: type of the data given to the PLC ... | pyads/ads.py | def read_write(
adr,
index_group,
index_offset,
plc_read_datatype,
value,
plc_write_datatype,
return_ctypes=False,
):
# type: (AmsAddr, int, int, Type, Any, Type, bool) -> Any
"""Read and write data synchronous from/to an ADS-device.
:param AmsAddr adr: local or remo... | def read_write(
adr,
index_group,
index_offset,
plc_read_datatype,
value,
plc_write_datatype,
return_ctypes=False,
):
# type: (AmsAddr, int, int, Type, Any, Type, bool) -> Any
"""Read and write data synchronous from/to an ADS-device.
:param AmsAddr adr: local or remo... | [
"Read",
"and",
"write",
"data",
"synchronous",
"from",
"/",
"to",
"an",
"ADS",
"-",
"device",
".",
":",
"param",
"AmsAddr",
"adr",
":",
"local",
"or",
"remote",
"AmsAddr",
":",
"param",
"int",
"index_group",
":",
"PLC",
"storage",
"area",
"according",
"t... | stlehmann/pyads | python | https://github.com/stlehmann/pyads/blob/44bd84394db2785332ac44b2948373916bea0f02/pyads/ads.py#L233-L272 | [
"def",
"read_write",
"(",
"adr",
",",
"index_group",
",",
"index_offset",
",",
"plc_read_datatype",
",",
"value",
",",
"plc_write_datatype",
",",
"return_ctypes",
"=",
"False",
",",
")",
":",
"# type: (AmsAddr, int, int, Type, Any, Type, bool) -> Any\r",
"if",
"port",
... | 44bd84394db2785332ac44b2948373916bea0f02 |
valid | read | Read data synchronous from an ADS-device.
:param AmsAddr adr: local or remote AmsAddr
:param int index_group: PLC storage area, according to the INDEXGROUP
constants
:param int index_offset: PLC storage address
:param int plc_datatype: type of the data given to the PLC, according to
... | pyads/ads.py | def read(adr, index_group, index_offset, plc_datatype, return_ctypes=False):
# type: (AmsAddr, int, int, Type, bool) -> Any
"""Read data synchronous from an ADS-device.
:param AmsAddr adr: local or remote AmsAddr
:param int index_group: PLC storage area, according to the INDEXGROUP
co... | def read(adr, index_group, index_offset, plc_datatype, return_ctypes=False):
# type: (AmsAddr, int, int, Type, bool) -> Any
"""Read data synchronous from an ADS-device.
:param AmsAddr adr: local or remote AmsAddr
:param int index_group: PLC storage area, according to the INDEXGROUP
co... | [
"Read",
"data",
"synchronous",
"from",
"an",
"ADS",
"-",
"device",
".",
":",
"param",
"AmsAddr",
"adr",
":",
"local",
"or",
"remote",
"AmsAddr",
":",
"param",
"int",
"index_group",
":",
"PLC",
"storage",
"area",
"according",
"to",
"the",
"INDEXGROUP",
"con... | stlehmann/pyads | python | https://github.com/stlehmann/pyads/blob/44bd84394db2785332ac44b2948373916bea0f02/pyads/ads.py#L275-L295 | [
"def",
"read",
"(",
"adr",
",",
"index_group",
",",
"index_offset",
",",
"plc_datatype",
",",
"return_ctypes",
"=",
"False",
")",
":",
"# type: (AmsAddr, int, int, Type, bool) -> Any\r",
"if",
"port",
"is",
"not",
"None",
":",
"return",
"adsSyncReadReqEx2",
"(",
"... | 44bd84394db2785332ac44b2948373916bea0f02 |
valid | read_by_name | Read data synchronous from an ADS-device from data name.
:param AmsAddr adr: local or remote AmsAddr
:param string data_name: data name
:param int plc_datatype: type of the data given to the PLC, according to
PLCTYPE constants
:param bool return_ctypes: return ctypes instead of python typ... | pyads/ads.py | def read_by_name(adr, data_name, plc_datatype, return_ctypes=False):
# type: (AmsAddr, str, Type, bool) -> Any
"""Read data synchronous from an ADS-device from data name.
:param AmsAddr adr: local or remote AmsAddr
:param string data_name: data name
:param int plc_datatype: type of the data g... | def read_by_name(adr, data_name, plc_datatype, return_ctypes=False):
# type: (AmsAddr, str, Type, bool) -> Any
"""Read data synchronous from an ADS-device from data name.
:param AmsAddr adr: local or remote AmsAddr
:param string data_name: data name
:param int plc_datatype: type of the data g... | [
"Read",
"data",
"synchronous",
"from",
"an",
"ADS",
"-",
"device",
"from",
"data",
"name",
".",
":",
"param",
"AmsAddr",
"adr",
":",
"local",
"or",
"remote",
"AmsAddr",
":",
"param",
"string",
"data_name",
":",
"data",
"name",
":",
"param",
"int",
"plc_d... | stlehmann/pyads | python | https://github.com/stlehmann/pyads/blob/44bd84394db2785332ac44b2948373916bea0f02/pyads/ads.py#L298-L314 | [
"def",
"read_by_name",
"(",
"adr",
",",
"data_name",
",",
"plc_datatype",
",",
"return_ctypes",
"=",
"False",
")",
":",
"# type: (AmsAddr, str, Type, bool) -> Any\r",
"if",
"port",
"is",
"not",
"None",
":",
"return",
"adsSyncReadByNameEx",
"(",
"port",
",",
"adr",... | 44bd84394db2785332ac44b2948373916bea0f02 |
valid | write_by_name | Send data synchronous to an ADS-device from data name.
:param AmsAddr adr: local or remote AmsAddr
:param string data_name: PLC storage address
:param value: value to write to the storage address of the PLC
:param int plc_datatype: type of the data given to the PLC,
according to PLCTYPE c... | pyads/ads.py | def write_by_name(adr, data_name, value, plc_datatype):
# type: (AmsAddr, str, Any, Type) -> None
"""Send data synchronous to an ADS-device from data name.
:param AmsAddr adr: local or remote AmsAddr
:param string data_name: PLC storage address
:param value: value to write to the storage addr... | def write_by_name(adr, data_name, value, plc_datatype):
# type: (AmsAddr, str, Any, Type) -> None
"""Send data synchronous to an ADS-device from data name.
:param AmsAddr adr: local or remote AmsAddr
:param string data_name: PLC storage address
:param value: value to write to the storage addr... | [
"Send",
"data",
"synchronous",
"to",
"an",
"ADS",
"-",
"device",
"from",
"data",
"name",
".",
":",
"param",
"AmsAddr",
"adr",
":",
"local",
"or",
"remote",
"AmsAddr",
":",
"param",
"string",
"data_name",
":",
"PLC",
"storage",
"address",
":",
"param",
"v... | stlehmann/pyads | python | https://github.com/stlehmann/pyads/blob/44bd84394db2785332ac44b2948373916bea0f02/pyads/ads.py#L317-L329 | [
"def",
"write_by_name",
"(",
"adr",
",",
"data_name",
",",
"value",
",",
"plc_datatype",
")",
":",
"# type: (AmsAddr, str, Any, Type) -> None\r",
"if",
"port",
"is",
"not",
"None",
":",
"return",
"adsSyncWriteByNameEx",
"(",
"port",
",",
"adr",
",",
"data_name",
... | 44bd84394db2785332ac44b2948373916bea0f02 |
valid | add_device_notification | Add a device notification.
:param pyads.structs.AmsAddr adr: AMS Address associated with the routing
entry which is to be removed from the router.
:param str data_name: PLC storage address
:param pyads.structs.NotificationAttrib attr: object that contains
all the attributes for the de... | pyads/ads.py | def add_device_notification(adr, data_name, attr, callback, user_handle=None):
# type: (AmsAddr, str, NotificationAttrib, Callable, int) -> Optional[Tuple[int, int]] # noqa: E501
"""Add a device notification.
:param pyads.structs.AmsAddr adr: AMS Address associated with the routing
entry whic... | def add_device_notification(adr, data_name, attr, callback, user_handle=None):
# type: (AmsAddr, str, NotificationAttrib, Callable, int) -> Optional[Tuple[int, int]] # noqa: E501
"""Add a device notification.
:param pyads.structs.AmsAddr adr: AMS Address associated with the routing
entry whic... | [
"Add",
"a",
"device",
"notification",
".",
":",
"param",
"pyads",
".",
"structs",
".",
"AmsAddr",
"adr",
":",
"AMS",
"Address",
"associated",
"with",
"the",
"routing",
"entry",
"which",
"is",
"to",
"be",
"removed",
"from",
"the",
"router",
".",
":",
"par... | stlehmann/pyads | python | https://github.com/stlehmann/pyads/blob/44bd84394db2785332ac44b2948373916bea0f02/pyads/ads.py#L352-L377 | [
"def",
"add_device_notification",
"(",
"adr",
",",
"data_name",
",",
"attr",
",",
"callback",
",",
"user_handle",
"=",
"None",
")",
":",
"# type: (AmsAddr, str, NotificationAttrib, Callable, int) -> Optional[Tuple[int, int]] # noqa: E501\r",
"if",
"port",
"is",
"not",
"Non... | 44bd84394db2785332ac44b2948373916bea0f02 |
valid | del_device_notification | Remove a device notification.
:param pyads.structs.AmsAddr adr: AMS Address associated with the routing
entry which is to be removed from the router.
:param notification_handle: address of the variable that contains
the handle of the notification
:param user_handle: user handle | pyads/ads.py | def del_device_notification(adr, notification_handle, user_handle):
# type: (AmsAddr, int, int) -> None
"""Remove a device notification.
:param pyads.structs.AmsAddr adr: AMS Address associated with the routing
entry which is to be removed from the router.
:param notification_handle: addr... | def del_device_notification(adr, notification_handle, user_handle):
# type: (AmsAddr, int, int) -> None
"""Remove a device notification.
:param pyads.structs.AmsAddr adr: AMS Address associated with the routing
entry which is to be removed from the router.
:param notification_handle: addr... | [
"Remove",
"a",
"device",
"notification",
".",
":",
"param",
"pyads",
".",
"structs",
".",
"AmsAddr",
"adr",
":",
"AMS",
"Address",
"associated",
"with",
"the",
"routing",
"entry",
"which",
"is",
"to",
"be",
"removed",
"from",
"the",
"router",
".",
":",
"... | stlehmann/pyads | python | https://github.com/stlehmann/pyads/blob/44bd84394db2785332ac44b2948373916bea0f02/pyads/ads.py#L380-L394 | [
"def",
"del_device_notification",
"(",
"adr",
",",
"notification_handle",
",",
"user_handle",
")",
":",
"# type: (AmsAddr, int, int) -> None\r",
"if",
"port",
"is",
"not",
"None",
":",
"return",
"adsSyncDelDeviceNotificationReqEx",
"(",
"port",
",",
"adr",
",",
"notif... | 44bd84394db2785332ac44b2948373916bea0f02 |
valid | Connection.open | Connect to the TwinCAT message router. | pyads/ads.py | def open(self):
# type: () -> None
"""Connect to the TwinCAT message router."""
if self._open:
return
self._port = adsPortOpenEx()
if linux:
adsAddRoute(self._adr.netIdStruct(), self.ip_address)
self._open = True | def open(self):
# type: () -> None
"""Connect to the TwinCAT message router."""
if self._open:
return
self._port = adsPortOpenEx()
if linux:
adsAddRoute(self._adr.netIdStruct(), self.ip_address)
self._open = True | [
"Connect",
"to",
"the",
"TwinCAT",
"message",
"router",
"."
] | stlehmann/pyads | python | https://github.com/stlehmann/pyads/blob/44bd84394db2785332ac44b2948373916bea0f02/pyads/ads.py#L438-L449 | [
"def",
"open",
"(",
"self",
")",
":",
"# type: () -> None\r",
"if",
"self",
".",
"_open",
":",
"return",
"self",
".",
"_port",
"=",
"adsPortOpenEx",
"(",
")",
"if",
"linux",
":",
"adsAddRoute",
"(",
"self",
".",
"_adr",
".",
"netIdStruct",
"(",
")",
",... | 44bd84394db2785332ac44b2948373916bea0f02 |
valid | Connection.close | :summary: Close the connection to the TwinCAT message router. | pyads/ads.py | def close(self):
# type: () -> None
""":summary: Close the connection to the TwinCAT message router."""
if not self._open:
return
if linux:
adsDelRoute(self._adr.netIdStruct())
if self._port is not None:
adsPortCloseEx(self._port)
... | def close(self):
# type: () -> None
""":summary: Close the connection to the TwinCAT message router."""
if not self._open:
return
if linux:
adsDelRoute(self._adr.netIdStruct())
if self._port is not None:
adsPortCloseEx(self._port)
... | [
":",
"summary",
":",
"Close",
"the",
"connection",
"to",
"the",
"TwinCAT",
"message",
"router",
"."
] | stlehmann/pyads | python | https://github.com/stlehmann/pyads/blob/44bd84394db2785332ac44b2948373916bea0f02/pyads/ads.py#L451-L464 | [
"def",
"close",
"(",
"self",
")",
":",
"# type: () -> None\r",
"if",
"not",
"self",
".",
"_open",
":",
"return",
"if",
"linux",
":",
"adsDelRoute",
"(",
"self",
".",
"_adr",
".",
"netIdStruct",
"(",
")",
")",
"if",
"self",
".",
"_port",
"is",
"not",
... | 44bd84394db2785332ac44b2948373916bea0f02 |
valid | Connection.write_control | Change the ADS state and the machine-state of the ADS-server.
:param int ads_state: new ADS-state, according to ADSTATE constants
:param int device_state: new machine-state
:param data: additional data
:param int plc_datatype: datatype, according to PLCTYPE constants
:no... | pyads/ads.py | def write_control(self, ads_state, device_state, data, plc_datatype):
# type: (int, int, Any, Type) -> None
"""Change the ADS state and the machine-state of the ADS-server.
:param int ads_state: new ADS-state, according to ADSTATE constants
:param int device_state: new machine-stat... | def write_control(self, ads_state, device_state, data, plc_datatype):
# type: (int, int, Any, Type) -> None
"""Change the ADS state and the machine-state of the ADS-server.
:param int ads_state: new ADS-state, according to ADSTATE constants
:param int device_state: new machine-stat... | [
"Change",
"the",
"ADS",
"state",
"and",
"the",
"machine",
"-",
"state",
"of",
"the",
"ADS",
"-",
"server",
".",
":",
"param",
"int",
"ads_state",
":",
"new",
"ADS",
"-",
"state",
"according",
"to",
"ADSTATE",
"constants",
":",
"param",
"int",
"device_sta... | stlehmann/pyads | python | https://github.com/stlehmann/pyads/blob/44bd84394db2785332ac44b2948373916bea0f02/pyads/ads.py#L493-L514 | [
"def",
"write_control",
"(",
"self",
",",
"ads_state",
",",
"device_state",
",",
"data",
",",
"plc_datatype",
")",
":",
"# type: (int, int, Any, Type) -> None\r",
"if",
"self",
".",
"_port",
"is",
"not",
"None",
":",
"return",
"adsSyncWriteControlReqEx",
"(",
"sel... | 44bd84394db2785332ac44b2948373916bea0f02 |
valid | Connection.write | Send data synchronous to an ADS-device.
:param int index_group: PLC storage area, according to the INDEXGROUP
constants
:param int index_offset: PLC storage address
:param value: value to write to the storage address of the PLC
:param int plc_datatype: type of the data... | pyads/ads.py | def write(self, index_group, index_offset, value, plc_datatype):
# type: (int, int, Any, Type) -> None
"""Send data synchronous to an ADS-device.
:param int index_group: PLC storage area, according to the INDEXGROUP
constants
:param int index_offset: PLC storage addres... | def write(self, index_group, index_offset, value, plc_datatype):
# type: (int, int, Any, Type) -> None
"""Send data synchronous to an ADS-device.
:param int index_group: PLC storage area, according to the INDEXGROUP
constants
:param int index_offset: PLC storage addres... | [
"Send",
"data",
"synchronous",
"to",
"an",
"ADS",
"-",
"device",
".",
":",
"param",
"int",
"index_group",
":",
"PLC",
"storage",
"area",
"according",
"to",
"the",
"INDEXGROUP",
"constants",
":",
"param",
"int",
"index_offset",
":",
"PLC",
"storage",
"address... | stlehmann/pyads | python | https://github.com/stlehmann/pyads/blob/44bd84394db2785332ac44b2948373916bea0f02/pyads/ads.py#L529-L544 | [
"def",
"write",
"(",
"self",
",",
"index_group",
",",
"index_offset",
",",
"value",
",",
"plc_datatype",
")",
":",
"# type: (int, int, Any, Type) -> None\r",
"if",
"self",
".",
"_port",
"is",
"not",
"None",
":",
"return",
"adsSyncWriteReqEx",
"(",
"self",
".",
... | 44bd84394db2785332ac44b2948373916bea0f02 |
valid | Connection.read_write | Read and write data synchronous from/to an ADS-device.
:param int index_group: PLC storage area, according to the INDEXGROUP
constants
:param int index_offset: PLC storage address
:param int plc_read_datatype: type of the data given to the PLC to
respond to, accord... | pyads/ads.py | def read_write(
self,
index_group,
index_offset,
plc_read_datatype,
value,
plc_write_datatype,
return_ctypes=False,
):
# type: (int, int, Type, Any, Type, bool) -> Any
"""Read and write data synchronous from/to an ADS-device.
... | def read_write(
self,
index_group,
index_offset,
plc_read_datatype,
value,
plc_write_datatype,
return_ctypes=False,
):
# type: (int, int, Type, Any, Type, bool) -> Any
"""Read and write data synchronous from/to an ADS-device.
... | [
"Read",
"and",
"write",
"data",
"synchronous",
"from",
"/",
"to",
"an",
"ADS",
"-",
"device",
".",
":",
"param",
"int",
"index_group",
":",
"PLC",
"storage",
"area",
"according",
"to",
"the",
"INDEXGROUP",
"constants",
":",
"param",
"int",
"index_offset",
... | stlehmann/pyads | python | https://github.com/stlehmann/pyads/blob/44bd84394db2785332ac44b2948373916bea0f02/pyads/ads.py#L546-L584 | [
"def",
"read_write",
"(",
"self",
",",
"index_group",
",",
"index_offset",
",",
"plc_read_datatype",
",",
"value",
",",
"plc_write_datatype",
",",
"return_ctypes",
"=",
"False",
",",
")",
":",
"# type: (int, int, Type, Any, Type, bool) -> Any\r",
"if",
"self",
".",
... | 44bd84394db2785332ac44b2948373916bea0f02 |
valid | Connection.read | Read data synchronous from an ADS-device.
:param int index_group: PLC storage area, according to the INDEXGROUP
constants
:param int index_offset: PLC storage address
:param int plc_datatype: type of the data given to the PLC, according
to PLCTYPE constants
... | pyads/ads.py | def read(self, index_group, index_offset, plc_datatype, return_ctypes=False):
# type: (int, int, Type, bool) -> Any
"""Read data synchronous from an ADS-device.
:param int index_group: PLC storage area, according to the INDEXGROUP
constants
:param int index_offset: PLC... | def read(self, index_group, index_offset, plc_datatype, return_ctypes=False):
# type: (int, int, Type, bool) -> Any
"""Read data synchronous from an ADS-device.
:param int index_group: PLC storage area, according to the INDEXGROUP
constants
:param int index_offset: PLC... | [
"Read",
"data",
"synchronous",
"from",
"an",
"ADS",
"-",
"device",
".",
":",
"param",
"int",
"index_group",
":",
"PLC",
"storage",
"area",
"according",
"to",
"the",
"INDEXGROUP",
"constants",
":",
"param",
"int",
"index_offset",
":",
"PLC",
"storage",
"addre... | stlehmann/pyads | python | https://github.com/stlehmann/pyads/blob/44bd84394db2785332ac44b2948373916bea0f02/pyads/ads.py#L586-L605 | [
"def",
"read",
"(",
"self",
",",
"index_group",
",",
"index_offset",
",",
"plc_datatype",
",",
"return_ctypes",
"=",
"False",
")",
":",
"# type: (int, int, Type, bool) -> Any\r",
"if",
"self",
".",
"_port",
"is",
"not",
"None",
":",
"return",
"adsSyncReadReqEx2",
... | 44bd84394db2785332ac44b2948373916bea0f02 |
valid | Connection.read_by_name | Read data synchronous from an ADS-device from data name.
:param string data_name: data name
:param int plc_datatype: type of the data given to the PLC, according
to PLCTYPE constants
:return: value: **value**
:param bool return_ctypes: return ctypes instead of pyth... | pyads/ads.py | def read_by_name(self, data_name, plc_datatype, return_ctypes=False):
# type: (str, Type, bool) -> Any
"""Read data synchronous from an ADS-device from data name.
:param string data_name: data name
:param int plc_datatype: type of the data given to the PLC, according
t... | def read_by_name(self, data_name, plc_datatype, return_ctypes=False):
# type: (str, Type, bool) -> Any
"""Read data synchronous from an ADS-device from data name.
:param string data_name: data name
:param int plc_datatype: type of the data given to the PLC, according
t... | [
"Read",
"data",
"synchronous",
"from",
"an",
"ADS",
"-",
"device",
"from",
"data",
"name",
".",
":",
"param",
"string",
"data_name",
":",
"data",
"name",
":",
"param",
"int",
"plc_datatype",
":",
"type",
"of",
"the",
"data",
"given",
"to",
"the",
"PLC",
... | stlehmann/pyads | python | https://github.com/stlehmann/pyads/blob/44bd84394db2785332ac44b2948373916bea0f02/pyads/ads.py#L607-L622 | [
"def",
"read_by_name",
"(",
"self",
",",
"data_name",
",",
"plc_datatype",
",",
"return_ctypes",
"=",
"False",
")",
":",
"# type: (str, Type, bool) -> Any\r",
"if",
"self",
".",
"_port",
":",
"return",
"adsSyncReadByNameEx",
"(",
"self",
".",
"_port",
",",
"self... | 44bd84394db2785332ac44b2948373916bea0f02 |
valid | Connection.write_by_name | Send data synchronous to an ADS-device from data name.
:param string data_name: PLC storage address
:param value: value to write to the storage address of the PLC
:param int plc_datatype: type of the data given to the PLC,
according to PLCTYPE constants | pyads/ads.py | def write_by_name(self, data_name, value, plc_datatype):
# type: (str, Any, Type) -> None
"""Send data synchronous to an ADS-device from data name.
:param string data_name: PLC storage address
:param value: value to write to the storage address of the PLC
:param int plc_da... | def write_by_name(self, data_name, value, plc_datatype):
# type: (str, Any, Type) -> None
"""Send data synchronous to an ADS-device from data name.
:param string data_name: PLC storage address
:param value: value to write to the storage address of the PLC
:param int plc_da... | [
"Send",
"data",
"synchronous",
"to",
"an",
"ADS",
"-",
"device",
"from",
"data",
"name",
".",
":",
"param",
"string",
"data_name",
":",
"PLC",
"storage",
"address",
":",
"param",
"value",
":",
"value",
"to",
"write",
"to",
"the",
"storage",
"address",
"o... | stlehmann/pyads | python | https://github.com/stlehmann/pyads/blob/44bd84394db2785332ac44b2948373916bea0f02/pyads/ads.py#L624-L637 | [
"def",
"write_by_name",
"(",
"self",
",",
"data_name",
",",
"value",
",",
"plc_datatype",
")",
":",
"# type: (str, Any, Type) -> None\r",
"if",
"self",
".",
"_port",
":",
"return",
"adsSyncWriteByNameEx",
"(",
"self",
".",
"_port",
",",
"self",
".",
"_adr",
",... | 44bd84394db2785332ac44b2948373916bea0f02 |
valid | Connection.add_device_notification | Add a device notification.
:param str data_name: PLC storage address
:param pyads.structs.NotificationAttrib attr: object that contains
all the attributes for the definition of a notification
:param callback: callback function that gets executed on in the event
of ... | pyads/ads.py | def add_device_notification(self, data_name, attr, callback, user_handle=None):
# type: (str, NotificationAttrib, Callable, int) -> Optional[Tuple[int, int]]
"""Add a device notification.
:param str data_name: PLC storage address
:param pyads.structs.NotificationAttrib attr: object... | def add_device_notification(self, data_name, attr, callback, user_handle=None):
# type: (str, NotificationAttrib, Callable, int) -> Optional[Tuple[int, int]]
"""Add a device notification.
:param str data_name: PLC storage address
:param pyads.structs.NotificationAttrib attr: object... | [
"Add",
"a",
"device",
"notification",
".",
":",
"param",
"str",
"data_name",
":",
"PLC",
"storage",
"address",
":",
"param",
"pyads",
".",
"structs",
".",
"NotificationAttrib",
"attr",
":",
"object",
"that",
"contains",
"all",
"the",
"attributes",
"for",
"th... | stlehmann/pyads | python | https://github.com/stlehmann/pyads/blob/44bd84394db2785332ac44b2948373916bea0f02/pyads/ads.py#L639-L690 | [
"def",
"add_device_notification",
"(",
"self",
",",
"data_name",
",",
"attr",
",",
"callback",
",",
"user_handle",
"=",
"None",
")",
":",
"# type: (str, NotificationAttrib, Callable, int) -> Optional[Tuple[int, int]]\r",
"if",
"self",
".",
"_port",
"is",
"not",
"None",
... | 44bd84394db2785332ac44b2948373916bea0f02 |
valid | Connection.del_device_notification | Remove a device notification.
:param notification_handle: address of the variable that contains
the handle of the notification
:param user_handle: user handle | pyads/ads.py | def del_device_notification(self, notification_handle, user_handle):
# type: (int, int) -> None
"""Remove a device notification.
:param notification_handle: address of the variable that contains
the handle of the notification
:param user_handle: user handle
... | def del_device_notification(self, notification_handle, user_handle):
# type: (int, int) -> None
"""Remove a device notification.
:param notification_handle: address of the variable that contains
the handle of the notification
:param user_handle: user handle
... | [
"Remove",
"a",
"device",
"notification",
".",
":",
"param",
"notification_handle",
":",
"address",
"of",
"the",
"variable",
"that",
"contains",
"the",
"handle",
"of",
"the",
"notification",
":",
"param",
"user_handle",
":",
"user",
"handle"
] | stlehmann/pyads | python | https://github.com/stlehmann/pyads/blob/44bd84394db2785332ac44b2948373916bea0f02/pyads/ads.py#L692-L704 | [
"def",
"del_device_notification",
"(",
"self",
",",
"notification_handle",
",",
"user_handle",
")",
":",
"# type: (int, int) -> None\r",
"if",
"self",
".",
"_port",
"is",
"not",
"None",
":",
"adsSyncDelDeviceNotificationReqEx",
"(",
"self",
".",
"_port",
",",
"self"... | 44bd84394db2785332ac44b2948373916bea0f02 |
valid | Connection.notification | Decorate a callback function.
**Decorator**.
A decorator that can be used for callback functions in order to
convert the data of the NotificationHeader into the fitting
Python type.
:param plc_datatype: The PLC datatype that needs to be converted. This can
be ... | pyads/ads.py | def notification(self, plc_datatype=None):
# type: (Optional[Type[Any]]) -> Callable
"""Decorate a callback function.
**Decorator**.
A decorator that can be used for callback functions in order to
convert the data of the NotificationHeader into the fitting
Pytho... | def notification(self, plc_datatype=None):
# type: (Optional[Type[Any]]) -> Callable
"""Decorate a callback function.
**Decorator**.
A decorator that can be used for callback functions in order to
convert the data of the NotificationHeader into the fitting
Pytho... | [
"Decorate",
"a",
"callback",
"function",
".",
"**",
"Decorator",
"**",
".",
"A",
"decorator",
"that",
"can",
"be",
"used",
"for",
"callback",
"functions",
"in",
"order",
"to",
"convert",
"the",
"data",
"of",
"the",
"NotificationHeader",
"into",
"the",
"fitti... | stlehmann/pyads | python | https://github.com/stlehmann/pyads/blob/44bd84394db2785332ac44b2948373916bea0f02/pyads/ads.py#L722-L815 | [
"def",
"notification",
"(",
"self",
",",
"plc_datatype",
"=",
"None",
")",
":",
"# type: (Optional[Type[Any]]) -> Callable\r",
"def",
"notification_decorator",
"(",
"func",
")",
":",
"# type: (Callable[[int, str, datetime, Any], None]) -> Callable[[Any, str], None] # noqa: E501\r",... | 44bd84394db2785332ac44b2948373916bea0f02 |
valid | xml_extract_text | :param node: the node to be queried
:param xpath: the path to fetch the child node that has the wanted text | serenata_toolbox/datasets/helpers.py | def xml_extract_text(node, xpath):
"""
:param node: the node to be queried
:param xpath: the path to fetch the child node that has the wanted text
"""
text = node.find(xpath).text
if text is not None:
text = text.strip()
return text | def xml_extract_text(node, xpath):
"""
:param node: the node to be queried
:param xpath: the path to fetch the child node that has the wanted text
"""
text = node.find(xpath).text
if text is not None:
text = text.strip()
return text | [
":",
"param",
"node",
":",
"the",
"node",
"to",
"be",
"queried",
":",
"param",
"xpath",
":",
"the",
"path",
"to",
"fetch",
"the",
"child",
"node",
"that",
"has",
"the",
"wanted",
"text"
] | okfn-brasil/serenata-toolbox | python | https://github.com/okfn-brasil/serenata-toolbox/blob/47b14725e8ed3a53fb52190a2ba5f29182a16959/serenata_toolbox/datasets/helpers.py#L14-L22 | [
"def",
"xml_extract_text",
"(",
"node",
",",
"xpath",
")",
":",
"text",
"=",
"node",
".",
"find",
"(",
"xpath",
")",
".",
"text",
"if",
"text",
"is",
"not",
"None",
":",
"text",
"=",
"text",
".",
"strip",
"(",
")",
"return",
"text"
] | 47b14725e8ed3a53fb52190a2ba5f29182a16959 |
valid | xml_extract_date | :param node: the node to be queried
:param xpath: the path to fetch the child node that has the wanted date | serenata_toolbox/datasets/helpers.py | def xml_extract_date(node, xpath, date_format='%d/%m/%Y'):
"""
:param node: the node to be queried
:param xpath: the path to fetch the child node that has the wanted date
"""
return datetime.strptime(xml_extract_text(node, xpath), date_format) | def xml_extract_date(node, xpath, date_format='%d/%m/%Y'):
"""
:param node: the node to be queried
:param xpath: the path to fetch the child node that has the wanted date
"""
return datetime.strptime(xml_extract_text(node, xpath), date_format) | [
":",
"param",
"node",
":",
"the",
"node",
"to",
"be",
"queried",
":",
"param",
"xpath",
":",
"the",
"path",
"to",
"fetch",
"the",
"child",
"node",
"that",
"has",
"the",
"wanted",
"date"
] | okfn-brasil/serenata-toolbox | python | https://github.com/okfn-brasil/serenata-toolbox/blob/47b14725e8ed3a53fb52190a2ba5f29182a16959/serenata_toolbox/datasets/helpers.py#L25-L30 | [
"def",
"xml_extract_date",
"(",
"node",
",",
"xpath",
",",
"date_format",
"=",
"'%d/%m/%Y'",
")",
":",
"return",
"datetime",
".",
"strptime",
"(",
"xml_extract_text",
"(",
"node",
",",
"xpath",
")",
",",
"date_format",
")"
] | 47b14725e8ed3a53fb52190a2ba5f29182a16959 |
valid | xml_extract_datetime | :param node: the node to be queried
:param xpath: the path to fetch the child node that has the wanted datetime | serenata_toolbox/datasets/helpers.py | def xml_extract_datetime(node, xpath, datetime_format='%d/%m/%Y %H:%M:%S'):
"""
:param node: the node to be queried
:param xpath: the path to fetch the child node that has the wanted datetime
"""
return datetime.strptime(xml_extract_text(node, xpath), datetime_format) | def xml_extract_datetime(node, xpath, datetime_format='%d/%m/%Y %H:%M:%S'):
"""
:param node: the node to be queried
:param xpath: the path to fetch the child node that has the wanted datetime
"""
return datetime.strptime(xml_extract_text(node, xpath), datetime_format) | [
":",
"param",
"node",
":",
"the",
"node",
"to",
"be",
"queried",
":",
"param",
"xpath",
":",
"the",
"path",
"to",
"fetch",
"the",
"child",
"node",
"that",
"has",
"the",
"wanted",
"datetime"
] | okfn-brasil/serenata-toolbox | python | https://github.com/okfn-brasil/serenata-toolbox/blob/47b14725e8ed3a53fb52190a2ba5f29182a16959/serenata_toolbox/datasets/helpers.py#L33-L38 | [
"def",
"xml_extract_datetime",
"(",
"node",
",",
"xpath",
",",
"datetime_format",
"=",
"'%d/%m/%Y %H:%M:%S'",
")",
":",
"return",
"datetime",
".",
"strptime",
"(",
"xml_extract_text",
"(",
"node",
",",
"xpath",
")",
",",
"datetime_format",
")"
] | 47b14725e8ed3a53fb52190a2ba5f29182a16959 |
valid | translate_column | :param df: (pandas.Dataframe) the dataframe to be translated
:param column: (str) the column to be translated
:param translations: (dict) a dictionary of the strings to be categorized and translated | serenata_toolbox/datasets/helpers.py | def translate_column(df, column, translations):
"""
:param df: (pandas.Dataframe) the dataframe to be translated
:param column: (str) the column to be translated
:param translations: (dict) a dictionary of the strings to be categorized and translated
"""
df[column] = df[column].astype('category'... | def translate_column(df, column, translations):
"""
:param df: (pandas.Dataframe) the dataframe to be translated
:param column: (str) the column to be translated
:param translations: (dict) a dictionary of the strings to be categorized and translated
"""
df[column] = df[column].astype('category'... | [
":",
"param",
"df",
":",
"(",
"pandas",
".",
"Dataframe",
")",
"the",
"dataframe",
"to",
"be",
"translated",
":",
"param",
"column",
":",
"(",
"str",
")",
"the",
"column",
"to",
"be",
"translated",
":",
"param",
"translations",
":",
"(",
"dict",
")",
... | okfn-brasil/serenata-toolbox | python | https://github.com/okfn-brasil/serenata-toolbox/blob/47b14725e8ed3a53fb52190a2ba5f29182a16959/serenata_toolbox/datasets/helpers.py#L43-L52 | [
"def",
"translate_column",
"(",
"df",
",",
"column",
",",
"translations",
")",
":",
"df",
"[",
"column",
"]",
"=",
"df",
"[",
"column",
"]",
".",
"astype",
"(",
"'category'",
")",
"translations",
"=",
"[",
"translations",
"[",
"cat",
"]",
"for",
"cat",... | 47b14725e8ed3a53fb52190a2ba5f29182a16959 |
valid | fetch_speeches | :param data_dir: (str) directory in which the output file will be saved
:param range_start: (str) date in the format dd/mm/yyyy
:param range_end: (str) date in the format dd/mm/yyyy | serenata_toolbox/chamber_of_deputies/speeches_dataset.py | def fetch_speeches(data_dir, range_start, range_end):
"""
:param data_dir: (str) directory in which the output file will be saved
:param range_start: (str) date in the format dd/mm/yyyy
:param range_end: (str) date in the format dd/mm/yyyy
"""
speeches = SpeechesDataset()
df = speeches.fetch... | def fetch_speeches(data_dir, range_start, range_end):
"""
:param data_dir: (str) directory in which the output file will be saved
:param range_start: (str) date in the format dd/mm/yyyy
:param range_end: (str) date in the format dd/mm/yyyy
"""
speeches = SpeechesDataset()
df = speeches.fetch... | [
":",
"param",
"data_dir",
":",
"(",
"str",
")",
"directory",
"in",
"which",
"the",
"output",
"file",
"will",
"be",
"saved",
":",
"param",
"range_start",
":",
"(",
"str",
")",
"date",
"in",
"the",
"format",
"dd",
"/",
"mm",
"/",
"yyyy",
":",
"param",
... | okfn-brasil/serenata-toolbox | python | https://github.com/okfn-brasil/serenata-toolbox/blob/47b14725e8ed3a53fb52190a2ba5f29182a16959/serenata_toolbox/chamber_of_deputies/speeches_dataset.py#L99-L108 | [
"def",
"fetch_speeches",
"(",
"data_dir",
",",
"range_start",
",",
"range_end",
")",
":",
"speeches",
"=",
"SpeechesDataset",
"(",
")",
"df",
"=",
"speeches",
".",
"fetch",
"(",
"range_start",
",",
"range_end",
")",
"save_to_csv",
"(",
"df",
",",
"data_dir",... | 47b14725e8ed3a53fb52190a2ba5f29182a16959 |
valid | SpeechesDataset.fetch | Fetches speeches from the ListarDiscursosPlenario endpoint of the
SessoesReunioes (SessionsReunions) API.
The date range provided should be specified as a string using the
format supported by the API (%d/%m/%Y) | serenata_toolbox/chamber_of_deputies/speeches_dataset.py | def fetch(self, range_start, range_end):
"""
Fetches speeches from the ListarDiscursosPlenario endpoint of the
SessoesReunioes (SessionsReunions) API.
The date range provided should be specified as a string using the
format supported by the API (%d/%m/%Y)
"""
ran... | def fetch(self, range_start, range_end):
"""
Fetches speeches from the ListarDiscursosPlenario endpoint of the
SessoesReunioes (SessionsReunions) API.
The date range provided should be specified as a string using the
format supported by the API (%d/%m/%Y)
"""
ran... | [
"Fetches",
"speeches",
"from",
"the",
"ListarDiscursosPlenario",
"endpoint",
"of",
"the",
"SessoesReunioes",
"(",
"SessionsReunions",
")",
"API",
"."
] | okfn-brasil/serenata-toolbox | python | https://github.com/okfn-brasil/serenata-toolbox/blob/47b14725e8ed3a53fb52190a2ba5f29182a16959/serenata_toolbox/chamber_of_deputies/speeches_dataset.py#L24-L52 | [
"def",
"fetch",
"(",
"self",
",",
"range_start",
",",
"range_end",
")",
":",
"range_dates",
"=",
"{",
"'dataIni'",
":",
"range_start",
",",
"'dataFim'",
":",
"range_end",
"}",
"url",
"=",
"self",
".",
"URL",
".",
"format",
"(",
"*",
"*",
"range_dates",
... | 47b14725e8ed3a53fb52190a2ba5f29182a16959 |
valid | fetch_presences | :param data_dir: (str) directory in which the output file will be saved
:param deputies: (pandas.DataFrame) a dataframe with deputies data
:param date_start: (str) a date in the format dd/mm/yyyy
:param date_end: (str) a date in the format dd/mm/yyyy | serenata_toolbox/chamber_of_deputies/presences_dataset.py | def fetch_presences(data_dir, deputies, date_start, date_end):
"""
:param data_dir: (str) directory in which the output file will be saved
:param deputies: (pandas.DataFrame) a dataframe with deputies data
:param date_start: (str) a date in the format dd/mm/yyyy
:param date_end: (str) a date in the ... | def fetch_presences(data_dir, deputies, date_start, date_end):
"""
:param data_dir: (str) directory in which the output file will be saved
:param deputies: (pandas.DataFrame) a dataframe with deputies data
:param date_start: (str) a date in the format dd/mm/yyyy
:param date_end: (str) a date in the ... | [
":",
"param",
"data_dir",
":",
"(",
"str",
")",
"directory",
"in",
"which",
"the",
"output",
"file",
"will",
"be",
"saved",
":",
"param",
"deputies",
":",
"(",
"pandas",
".",
"DataFrame",
")",
"a",
"dataframe",
"with",
"deputies",
"data",
":",
"param",
... | okfn-brasil/serenata-toolbox | python | https://github.com/okfn-brasil/serenata-toolbox/blob/47b14725e8ed3a53fb52190a2ba5f29182a16959/serenata_toolbox/chamber_of_deputies/presences_dataset.py#L161-L176 | [
"def",
"fetch_presences",
"(",
"data_dir",
",",
"deputies",
",",
"date_start",
",",
"date_end",
")",
":",
"presences",
"=",
"PresencesDataset",
"(",
")",
"df",
"=",
"presences",
".",
"fetch",
"(",
"deputies",
",",
"date_start",
",",
"date_end",
")",
"save_to... | 47b14725e8ed3a53fb52190a2ba5f29182a16959 |
valid | PresencesDataset.fetch | :param deputies: (pandas.DataFrame) a dataframe with deputies data
:param date_start: (str) date in the format dd/mm/yyyy
:param date_end: (str) date in the format dd/mm/yyyy | serenata_toolbox/chamber_of_deputies/presences_dataset.py | def fetch(self, deputies, start_date, end_date):
"""
:param deputies: (pandas.DataFrame) a dataframe with deputies data
:param date_start: (str) date in the format dd/mm/yyyy
:param date_end: (str) date in the format dd/mm/yyyy
"""
log.debug("Fetching data for {} deputies... | def fetch(self, deputies, start_date, end_date):
"""
:param deputies: (pandas.DataFrame) a dataframe with deputies data
:param date_start: (str) date in the format dd/mm/yyyy
:param date_end: (str) date in the format dd/mm/yyyy
"""
log.debug("Fetching data for {} deputies... | [
":",
"param",
"deputies",
":",
"(",
"pandas",
".",
"DataFrame",
")",
"a",
"dataframe",
"with",
"deputies",
"data",
":",
"param",
"date_start",
":",
"(",
"str",
")",
"date",
"in",
"the",
"format",
"dd",
"/",
"mm",
"/",
"yyyy",
":",
"param",
"date_end",
... | okfn-brasil/serenata-toolbox | python | https://github.com/okfn-brasil/serenata-toolbox/blob/47b14725e8ed3a53fb52190a2ba5f29182a16959/serenata_toolbox/chamber_of_deputies/presences_dataset.py#L33-L55 | [
"def",
"fetch",
"(",
"self",
",",
"deputies",
",",
"start_date",
",",
"end_date",
")",
":",
"log",
".",
"debug",
"(",
"\"Fetching data for {} deputies from {} -> {}\"",
".",
"format",
"(",
"len",
"(",
"deputies",
")",
",",
"start_date",
",",
"end_date",
")",
... | 47b14725e8ed3a53fb52190a2ba5f29182a16959 |
valid | fetch_official_missions | :param data_dir: (str) directory in which the output file will be saved
:param start_date: (datetime) first date of the range to be scraped
:param end_date: (datetime) last date of the range to be scraped | serenata_toolbox/chamber_of_deputies/official_missions_dataset.py | def fetch_official_missions(data_dir, start_date, end_date):
"""
:param data_dir: (str) directory in which the output file will be saved
:param start_date: (datetime) first date of the range to be scraped
:param end_date: (datetime) last date of the range to be scraped
"""
official_missions = Of... | def fetch_official_missions(data_dir, start_date, end_date):
"""
:param data_dir: (str) directory in which the output file will be saved
:param start_date: (datetime) first date of the range to be scraped
:param end_date: (datetime) last date of the range to be scraped
"""
official_missions = Of... | [
":",
"param",
"data_dir",
":",
"(",
"str",
")",
"directory",
"in",
"which",
"the",
"output",
"file",
"will",
"be",
"saved",
":",
"param",
"start_date",
":",
"(",
"datetime",
")",
"first",
"date",
"of",
"the",
"range",
"to",
"be",
"scraped",
":",
"param... | okfn-brasil/serenata-toolbox | python | https://github.com/okfn-brasil/serenata-toolbox/blob/47b14725e8ed3a53fb52190a2ba5f29182a16959/serenata_toolbox/chamber_of_deputies/official_missions_dataset.py#L119-L129 | [
"def",
"fetch_official_missions",
"(",
"data_dir",
",",
"start_date",
",",
"end_date",
")",
":",
"official_missions",
"=",
"OfficialMissionsDataset",
"(",
")",
"df",
"=",
"official_missions",
".",
"fetch",
"(",
"start_date",
",",
"end_date",
")",
"save_to_csv",
"(... | 47b14725e8ed3a53fb52190a2ba5f29182a16959 |
valid | OfficialMissionsDataset.fetch | Fetches official missions within the given date range | serenata_toolbox/chamber_of_deputies/official_missions_dataset.py | def fetch(self, start_date, end_date):
"""
Fetches official missions within the given date range
"""
records = []
for two_months_range in self._generate_ranges(start_date, end_date):
log.debug(two_months_range)
for record in self._fetch_missions_for_range... | def fetch(self, start_date, end_date):
"""
Fetches official missions within the given date range
"""
records = []
for two_months_range in self._generate_ranges(start_date, end_date):
log.debug(two_months_range)
for record in self._fetch_missions_for_range... | [
"Fetches",
"official",
"missions",
"within",
"the",
"given",
"date",
"range"
] | okfn-brasil/serenata-toolbox | python | https://github.com/okfn-brasil/serenata-toolbox/blob/47b14725e8ed3a53fb52190a2ba5f29182a16959/serenata_toolbox/chamber_of_deputies/official_missions_dataset.py#L28-L61 | [
"def",
"fetch",
"(",
"self",
",",
"start_date",
",",
"end_date",
")",
":",
"records",
"=",
"[",
"]",
"for",
"two_months_range",
"in",
"self",
".",
"_generate_ranges",
"(",
"start_date",
",",
"end_date",
")",
":",
"log",
".",
"debug",
"(",
"two_months_range... | 47b14725e8ed3a53fb52190a2ba5f29182a16959 |
valid | OfficialMissionsDataset._generate_ranges | Generate a list of 2 month ranges for the range requested with an
intersection between months. This is necessary because we can't search
for ranges longer than 3 months and the period searched has to encompass
the whole period of the mission. | serenata_toolbox/chamber_of_deputies/official_missions_dataset.py | def _generate_ranges(start_date, end_date):
"""
Generate a list of 2 month ranges for the range requested with an
intersection between months. This is necessary because we can't search
for ranges longer than 3 months and the period searched has to encompass
the whole period of th... | def _generate_ranges(start_date, end_date):
"""
Generate a list of 2 month ranges for the range requested with an
intersection between months. This is necessary because we can't search
for ranges longer than 3 months and the period searched has to encompass
the whole period of th... | [
"Generate",
"a",
"list",
"of",
"2",
"month",
"ranges",
"for",
"the",
"range",
"requested",
"with",
"an",
"intersection",
"between",
"months",
".",
"This",
"is",
"necessary",
"because",
"we",
"can",
"t",
"search",
"for",
"ranges",
"longer",
"than",
"3",
"mo... | okfn-brasil/serenata-toolbox | python | https://github.com/okfn-brasil/serenata-toolbox/blob/47b14725e8ed3a53fb52190a2ba5f29182a16959/serenata_toolbox/chamber_of_deputies/official_missions_dataset.py#L64-L78 | [
"def",
"_generate_ranges",
"(",
"start_date",
",",
"end_date",
")",
":",
"range_start",
"=",
"start_date",
"while",
"range_start",
"<",
"end_date",
":",
"range_end",
"=",
"range_start",
"+",
"timedelta",
"(",
"days",
"=",
"60",
")",
"yield",
"(",
"range_start"... | 47b14725e8ed3a53fb52190a2ba5f29182a16959 |
valid | fetch_session_start_times | :param data_dir: (str) directory in which the output file will be saved
:param pivot: (int) congressperson document to use as a pivot for scraping the data
:param session_dates: (list) datetime objects to fetch the start times for | serenata_toolbox/chamber_of_deputies/session_start_times_dataset.py | def fetch_session_start_times(data_dir, pivot, session_dates):
"""
:param data_dir: (str) directory in which the output file will be saved
:param pivot: (int) congressperson document to use as a pivot for scraping the data
:param session_dates: (list) datetime objects to fetch the start times for
""... | def fetch_session_start_times(data_dir, pivot, session_dates):
"""
:param data_dir: (str) directory in which the output file will be saved
:param pivot: (int) congressperson document to use as a pivot for scraping the data
:param session_dates: (list) datetime objects to fetch the start times for
""... | [
":",
"param",
"data_dir",
":",
"(",
"str",
")",
"directory",
"in",
"which",
"the",
"output",
"file",
"will",
"be",
"saved",
":",
"param",
"pivot",
":",
"(",
"int",
")",
"congressperson",
"document",
"to",
"use",
"as",
"a",
"pivot",
"for",
"scraping",
"... | okfn-brasil/serenata-toolbox | python | https://github.com/okfn-brasil/serenata-toolbox/blob/47b14725e8ed3a53fb52190a2ba5f29182a16959/serenata_toolbox/chamber_of_deputies/session_start_times_dataset.py#L49-L62 | [
"def",
"fetch_session_start_times",
"(",
"data_dir",
",",
"pivot",
",",
"session_dates",
")",
":",
"session_start_times",
"=",
"SessionStartTimesDataset",
"(",
")",
"df",
"=",
"session_start_times",
".",
"fetch",
"(",
"pivot",
",",
"session_dates",
")",
"save_to_csv... | 47b14725e8ed3a53fb52190a2ba5f29182a16959 |
valid | SessionStartTimesDataset.fetch | :param pivot: (int) a congressperson document to use as a pivot for scraping the data
:param session_dates: (list) datetime objects to fetch the start times for | serenata_toolbox/chamber_of_deputies/session_start_times_dataset.py | def fetch(self, pivot, session_dates):
"""
:param pivot: (int) a congressperson document to use as a pivot for scraping the data
:param session_dates: (list) datetime objects to fetch the start times for
"""
records = self._all_start_times(pivot, session_dates)
return pd... | def fetch(self, pivot, session_dates):
"""
:param pivot: (int) a congressperson document to use as a pivot for scraping the data
:param session_dates: (list) datetime objects to fetch the start times for
"""
records = self._all_start_times(pivot, session_dates)
return pd... | [
":",
"param",
"pivot",
":",
"(",
"int",
")",
"a",
"congressperson",
"document",
"to",
"use",
"as",
"a",
"pivot",
"for",
"scraping",
"the",
"data",
":",
"param",
"session_dates",
":",
"(",
"list",
")",
"datetime",
"objects",
"to",
"fetch",
"the",
"start",... | okfn-brasil/serenata-toolbox | python | https://github.com/okfn-brasil/serenata-toolbox/blob/47b14725e8ed3a53fb52190a2ba5f29182a16959/serenata_toolbox/chamber_of_deputies/session_start_times_dataset.py#L23-L34 | [
"def",
"fetch",
"(",
"self",
",",
"pivot",
",",
"session_dates",
")",
":",
"records",
"=",
"self",
".",
"_all_start_times",
"(",
"pivot",
",",
"session_dates",
")",
"return",
"pd",
".",
"DataFrame",
"(",
"records",
",",
"columns",
"=",
"(",
"'date'",
","... | 47b14725e8ed3a53fb52190a2ba5f29182a16959 |
valid | fetch_deputies | :param data_dir: (str) directory in which the output file will be saved | serenata_toolbox/chamber_of_deputies/deputies_dataset.py | def fetch_deputies(data_dir):
"""
:param data_dir: (str) directory in which the output file will be saved
"""
deputies = DeputiesDataset()
df = deputies.fetch()
save_to_csv(df, data_dir, "deputies")
holders = df.condition == 'Holder'
substitutes = df.condition == 'Substitute'
log.in... | def fetch_deputies(data_dir):
"""
:param data_dir: (str) directory in which the output file will be saved
"""
deputies = DeputiesDataset()
df = deputies.fetch()
save_to_csv(df, data_dir, "deputies")
holders = df.condition == 'Holder'
substitutes = df.condition == 'Substitute'
log.in... | [
":",
"param",
"data_dir",
":",
"(",
"str",
")",
"directory",
"in",
"which",
"the",
"output",
"file",
"will",
"be",
"saved"
] | okfn-brasil/serenata-toolbox | python | https://github.com/okfn-brasil/serenata-toolbox/blob/47b14725e8ed3a53fb52190a2ba5f29182a16959/serenata_toolbox/chamber_of_deputies/deputies_dataset.py#L76-L89 | [
"def",
"fetch_deputies",
"(",
"data_dir",
")",
":",
"deputies",
"=",
"DeputiesDataset",
"(",
")",
"df",
"=",
"deputies",
".",
"fetch",
"(",
")",
"save_to_csv",
"(",
"df",
",",
"data_dir",
",",
"\"deputies\"",
")",
"holders",
"=",
"df",
".",
"condition",
... | 47b14725e8ed3a53fb52190a2ba5f29182a16959 |
valid | DeputiesDataset.fetch | Fetches the list of deputies for the current term. | serenata_toolbox/chamber_of_deputies/deputies_dataset.py | def fetch(self):
"""
Fetches the list of deputies for the current term.
"""
xml = urllib.request.urlopen(self.URL)
tree = ET.ElementTree(file=xml)
records = self._parse_deputies(tree.getroot())
df = pd.DataFrame(records, columns=(
'congressperson_id'... | def fetch(self):
"""
Fetches the list of deputies for the current term.
"""
xml = urllib.request.urlopen(self.URL)
tree = ET.ElementTree(file=xml)
records = self._parse_deputies(tree.getroot())
df = pd.DataFrame(records, columns=(
'congressperson_id'... | [
"Fetches",
"the",
"list",
"of",
"deputies",
"for",
"the",
"current",
"term",
"."
] | okfn-brasil/serenata-toolbox | python | https://github.com/okfn-brasil/serenata-toolbox/blob/47b14725e8ed3a53fb52190a2ba5f29182a16959/serenata_toolbox/chamber_of_deputies/deputies_dataset.py#L18-L41 | [
"def",
"fetch",
"(",
"self",
")",
":",
"xml",
"=",
"urllib",
".",
"request",
".",
"urlopen",
"(",
"self",
".",
"URL",
")",
"tree",
"=",
"ET",
".",
"ElementTree",
"(",
"file",
"=",
"xml",
")",
"records",
"=",
"self",
".",
"_parse_deputies",
"(",
"tr... | 47b14725e8ed3a53fb52190a2ba5f29182a16959 |
valid | HashRing.add_node | Adds a `node` to the hash ring (including a number of replicas). | redis_shard/hashring.py | def add_node(self, node):
"""Adds a `node` to the hash ring (including a number of replicas).
"""
self.nodes.append(node)
for x in xrange(self.replicas):
ring_key = self.hash_method(b("%s:%d" % (node, x)))
self.ring[ring_key] = node
self.sorted_keys.ap... | def add_node(self, node):
"""Adds a `node` to the hash ring (including a number of replicas).
"""
self.nodes.append(node)
for x in xrange(self.replicas):
ring_key = self.hash_method(b("%s:%d" % (node, x)))
self.ring[ring_key] = node
self.sorted_keys.ap... | [
"Adds",
"a",
"node",
"to",
"the",
"hash",
"ring",
"(",
"including",
"a",
"number",
"of",
"replicas",
")",
"."
] | zhihu/redis-shard | python | https://github.com/zhihu/redis-shard/blob/57c166ef7d55f7272b50efc1dedc1f6ed4691137/redis_shard/hashring.py#L45-L54 | [
"def",
"add_node",
"(",
"self",
",",
"node",
")",
":",
"self",
".",
"nodes",
".",
"append",
"(",
"node",
")",
"for",
"x",
"in",
"xrange",
"(",
"self",
".",
"replicas",
")",
":",
"ring_key",
"=",
"self",
".",
"hash_method",
"(",
"b",
"(",
"\"%s:%d\"... | 57c166ef7d55f7272b50efc1dedc1f6ed4691137 |
valid | HashRing.remove_node | Removes `node` from the hash ring and its replicas. | redis_shard/hashring.py | def remove_node(self, node):
"""Removes `node` from the hash ring and its replicas.
"""
self.nodes.remove(node)
for x in xrange(self.replicas):
ring_key = self.hash_method(b("%s:%d" % (node, x)))
self.ring.pop(ring_key)
self.sorted_keys.remove(ring_key... | def remove_node(self, node):
"""Removes `node` from the hash ring and its replicas.
"""
self.nodes.remove(node)
for x in xrange(self.replicas):
ring_key = self.hash_method(b("%s:%d" % (node, x)))
self.ring.pop(ring_key)
self.sorted_keys.remove(ring_key... | [
"Removes",
"node",
"from",
"the",
"hash",
"ring",
"and",
"its",
"replicas",
"."
] | zhihu/redis-shard | python | https://github.com/zhihu/redis-shard/blob/57c166ef7d55f7272b50efc1dedc1f6ed4691137/redis_shard/hashring.py#L56-L63 | [
"def",
"remove_node",
"(",
"self",
",",
"node",
")",
":",
"self",
".",
"nodes",
".",
"remove",
"(",
"node",
")",
"for",
"x",
"in",
"xrange",
"(",
"self",
".",
"replicas",
")",
":",
"ring_key",
"=",
"self",
".",
"hash_method",
"(",
"b",
"(",
"\"%s:%... | 57c166ef7d55f7272b50efc1dedc1f6ed4691137 |
valid | HashRing.get_node_pos | Given a string key a corresponding node in the hash ring is returned
along with it's position in the ring.
If the hash ring is empty, (`None`, `None`) is returned. | redis_shard/hashring.py | def get_node_pos(self, key):
"""Given a string key a corresponding node in the hash ring is returned
along with it's position in the ring.
If the hash ring is empty, (`None`, `None`) is returned.
"""
if len(self.ring) == 0:
return [None, None]
crc = self.hash... | def get_node_pos(self, key):
"""Given a string key a corresponding node in the hash ring is returned
along with it's position in the ring.
If the hash ring is empty, (`None`, `None`) is returned.
"""
if len(self.ring) == 0:
return [None, None]
crc = self.hash... | [
"Given",
"a",
"string",
"key",
"a",
"corresponding",
"node",
"in",
"the",
"hash",
"ring",
"is",
"returned",
"along",
"with",
"it",
"s",
"position",
"in",
"the",
"ring",
"."
] | zhihu/redis-shard | python | https://github.com/zhihu/redis-shard/blob/57c166ef7d55f7272b50efc1dedc1f6ed4691137/redis_shard/hashring.py#L73-L85 | [
"def",
"get_node_pos",
"(",
"self",
",",
"key",
")",
":",
"if",
"len",
"(",
"self",
".",
"ring",
")",
"==",
"0",
":",
"return",
"[",
"None",
",",
"None",
"]",
"crc",
"=",
"self",
".",
"hash_method",
"(",
"b",
"(",
"key",
")",
")",
"idx",
"=",
... | 57c166ef7d55f7272b50efc1dedc1f6ed4691137 |
valid | HashRing.iter_nodes | Given a string key it returns the nodes as a generator that can hold the key. | redis_shard/hashring.py | def iter_nodes(self, key):
"""Given a string key it returns the nodes as a generator that can hold the key.
"""
if len(self.ring) == 0:
yield None, None
node, pos = self.get_node_pos(key)
for k in self.sorted_keys[pos:]:
yield k, self.ring[k] | def iter_nodes(self, key):
"""Given a string key it returns the nodes as a generator that can hold the key.
"""
if len(self.ring) == 0:
yield None, None
node, pos = self.get_node_pos(key)
for k in self.sorted_keys[pos:]:
yield k, self.ring[k] | [
"Given",
"a",
"string",
"key",
"it",
"returns",
"the",
"nodes",
"as",
"a",
"generator",
"that",
"can",
"hold",
"the",
"key",
"."
] | zhihu/redis-shard | python | https://github.com/zhihu/redis-shard/blob/57c166ef7d55f7272b50efc1dedc1f6ed4691137/redis_shard/hashring.py#L87-L94 | [
"def",
"iter_nodes",
"(",
"self",
",",
"key",
")",
":",
"if",
"len",
"(",
"self",
".",
"ring",
")",
"==",
"0",
":",
"yield",
"None",
",",
"None",
"node",
",",
"pos",
"=",
"self",
".",
"get_node_pos",
"(",
"key",
")",
"for",
"k",
"in",
"self",
"... | 57c166ef7d55f7272b50efc1dedc1f6ed4691137 |
valid | format_servers | :param servers: server list, element in it can have two kinds of format.
- dict
servers = [
{'name':'node1','host':'127.0.0.1','port':10000,'db':0},
{'name':'node2','host':'127.0.0.1','port':11000,'db':0},
{'name':'node3','host':'127.0.0.1','port':12000,'db':0},
]
- url_s... | redis_shard/helpers.py | def format_servers(servers):
"""
:param servers: server list, element in it can have two kinds of format.
- dict
servers = [
{'name':'node1','host':'127.0.0.1','port':10000,'db':0},
{'name':'node2','host':'127.0.0.1','port':11000,'db':0},
{'name':'node3','host':'127.0.0.1','por... | def format_servers(servers):
"""
:param servers: server list, element in it can have two kinds of format.
- dict
servers = [
{'name':'node1','host':'127.0.0.1','port':10000,'db':0},
{'name':'node2','host':'127.0.0.1','port':11000,'db':0},
{'name':'node3','host':'127.0.0.1','por... | [
":",
"param",
"servers",
":",
"server",
"list",
"element",
"in",
"it",
"can",
"have",
"two",
"kinds",
"of",
"format",
"."
] | zhihu/redis-shard | python | https://github.com/zhihu/redis-shard/blob/57c166ef7d55f7272b50efc1dedc1f6ed4691137/redis_shard/helpers.py#L7-L40 | [
"def",
"format_servers",
"(",
"servers",
")",
":",
"configs",
"=",
"[",
"]",
"if",
"not",
"isinstance",
"(",
"servers",
",",
"list",
")",
":",
"raise",
"ValueError",
"(",
"\"server's config must be list\"",
")",
"_type",
"=",
"type",
"(",
"servers",
"[",
"... | 57c166ef7d55f7272b50efc1dedc1f6ed4691137 |
valid | RedisShardAPI.mget | Returns a list of values ordered identically to ``keys`` | redis_shard/shard.py | def mget(self, keys, *args):
"""
Returns a list of values ordered identically to ``keys``
"""
args = list_or_args(keys, args)
server_keys = {}
ret_dict = {}
for key in args:
server_name = self.get_server_name(key)
server_keys[server_name] =... | def mget(self, keys, *args):
"""
Returns a list of values ordered identically to ``keys``
"""
args = list_or_args(keys, args)
server_keys = {}
ret_dict = {}
for key in args:
server_name = self.get_server_name(key)
server_keys[server_name] =... | [
"Returns",
"a",
"list",
"of",
"values",
"ordered",
"identically",
"to",
"keys"
] | zhihu/redis-shard | python | https://github.com/zhihu/redis-shard/blob/57c166ef7d55f7272b50efc1dedc1f6ed4691137/redis_shard/shard.py#L140-L157 | [
"def",
"mget",
"(",
"self",
",",
"keys",
",",
"*",
"args",
")",
":",
"args",
"=",
"list_or_args",
"(",
"keys",
",",
"args",
")",
"server_keys",
"=",
"{",
"}",
"ret_dict",
"=",
"{",
"}",
"for",
"key",
"in",
"args",
":",
"server_name",
"=",
"self",
... | 57c166ef7d55f7272b50efc1dedc1f6ed4691137 |
valid | RedisShardAPI.mset | Sets each key in the ``mapping`` dict to its corresponding value | redis_shard/shard.py | def mset(self, mapping):
"""
Sets each key in the ``mapping`` dict to its corresponding value
"""
servers = {}
for key, value in mapping.items():
server_name = self.get_server_name(key)
servers.setdefault(server_name, [])
servers[server_name].a... | def mset(self, mapping):
"""
Sets each key in the ``mapping`` dict to its corresponding value
"""
servers = {}
for key, value in mapping.items():
server_name = self.get_server_name(key)
servers.setdefault(server_name, [])
servers[server_name].a... | [
"Sets",
"each",
"key",
"in",
"the",
"mapping",
"dict",
"to",
"its",
"corresponding",
"value"
] | zhihu/redis-shard | python | https://github.com/zhihu/redis-shard/blob/57c166ef7d55f7272b50efc1dedc1f6ed4691137/redis_shard/shard.py#L159-L170 | [
"def",
"mset",
"(",
"self",
",",
"mapping",
")",
":",
"servers",
"=",
"{",
"}",
"for",
"key",
",",
"value",
"in",
"mapping",
".",
"items",
"(",
")",
":",
"server_name",
"=",
"self",
".",
"get_server_name",
"(",
"key",
")",
"servers",
".",
"setdefault... | 57c166ef7d55f7272b50efc1dedc1f6ed4691137 |
valid | RedisShardAPI.lock | Return a new Lock object using key ``name`` that mimics
the behavior of threading.Lock.
If specified, ``timeout`` indicates a maximum life for the lock.
By default, it will remain locked until release() is called.
``sleep`` indicates the amount of time to sleep per loop iteration
... | redis_shard/shard.py | def lock(self, name, timeout=None, sleep=0.1):
"""
Return a new Lock object using key ``name`` that mimics
the behavior of threading.Lock.
If specified, ``timeout`` indicates a maximum life for the lock.
By default, it will remain locked until release() is called.
``sle... | def lock(self, name, timeout=None, sleep=0.1):
"""
Return a new Lock object using key ``name`` that mimics
the behavior of threading.Lock.
If specified, ``timeout`` indicates a maximum life for the lock.
By default, it will remain locked until release() is called.
``sle... | [
"Return",
"a",
"new",
"Lock",
"object",
"using",
"key",
"name",
"that",
"mimics",
"the",
"behavior",
"of",
"threading",
".",
"Lock",
"."
] | zhihu/redis-shard | python | https://github.com/zhihu/redis-shard/blob/57c166ef7d55f7272b50efc1dedc1f6ed4691137/redis_shard/shard.py#L177-L189 | [
"def",
"lock",
"(",
"self",
",",
"name",
",",
"timeout",
"=",
"None",
",",
"sleep",
"=",
"0.1",
")",
":",
"return",
"Lock",
"(",
"self",
",",
"name",
",",
"timeout",
"=",
"timeout",
",",
"sleep",
"=",
"sleep",
")"
] | 57c166ef7d55f7272b50efc1dedc1f6ed4691137 |
valid | parse_line | Return a language-server diagnostic from a line of the Mypy error report;
optionally, use the whole document to provide more context on it. | pyls_mypy/plugin.py | def parse_line(line, document=None):
'''
Return a language-server diagnostic from a line of the Mypy error report;
optionally, use the whole document to provide more context on it.
'''
result = re.match(line_pattern, line)
if result:
_, lineno, offset, severity, msg = result.groups()
... | def parse_line(line, document=None):
'''
Return a language-server diagnostic from a line of the Mypy error report;
optionally, use the whole document to provide more context on it.
'''
result = re.match(line_pattern, line)
if result:
_, lineno, offset, severity, msg = result.groups()
... | [
"Return",
"a",
"language",
"-",
"server",
"diagnostic",
"from",
"a",
"line",
"of",
"the",
"Mypy",
"error",
"report",
";",
"optionally",
"use",
"the",
"whole",
"document",
"to",
"provide",
"more",
"context",
"on",
"it",
"."
] | tomv564/pyls-mypy | python | https://github.com/tomv564/pyls-mypy/blob/e488270437ae444865fdf590ddec8943efbf2332/pyls_mypy/plugin.py#L8-L39 | [
"def",
"parse_line",
"(",
"line",
",",
"document",
"=",
"None",
")",
":",
"result",
"=",
"re",
".",
"match",
"(",
"line_pattern",
",",
"line",
")",
"if",
"result",
":",
"_",
",",
"lineno",
",",
"offset",
",",
"severity",
",",
"msg",
"=",
"result",
... | e488270437ae444865fdf590ddec8943efbf2332 |
valid | WebSocket.connect | Establishes a connection to the Lavalink server. | lavalink/WebSocket.py | async def connect(self):
""" Establishes a connection to the Lavalink server. """
await self._lavalink.bot.wait_until_ready()
if self._ws and self._ws.open:
log.debug('WebSocket still open, closing...')
await self._ws.close()
user_id = self._lavalink.bot... | async def connect(self):
""" Establishes a connection to the Lavalink server. """
await self._lavalink.bot.wait_until_ready()
if self._ws and self._ws.open:
log.debug('WebSocket still open, closing...')
await self._ws.close()
user_id = self._lavalink.bot... | [
"Establishes",
"a",
"connection",
"to",
"the",
"Lavalink",
"server",
"."
] | Devoxin/Lavalink.py | python | https://github.com/Devoxin/Lavalink.py/blob/63f55c3d726d24c4cfd3674d3cd6aab6f5be110d/lavalink/WebSocket.py#L36-L73 | [
"async",
"def",
"connect",
"(",
"self",
")",
":",
"await",
"self",
".",
"_lavalink",
".",
"bot",
".",
"wait_until_ready",
"(",
")",
"if",
"self",
".",
"_ws",
"and",
"self",
".",
"_ws",
".",
"open",
":",
"log",
".",
"debug",
"(",
"'WebSocket still open,... | 63f55c3d726d24c4cfd3674d3cd6aab6f5be110d |
valid | WebSocket._attempt_reconnect | Attempts to reconnect to the Lavalink server.
Returns
-------
bool
``True`` if the reconnection attempt was successful. | lavalink/WebSocket.py | async def _attempt_reconnect(self):
"""
Attempts to reconnect to the Lavalink server.
Returns
-------
bool
``True`` if the reconnection attempt was successful.
"""
log.info('Connection closed; attempting to reconnect in 30 seconds')
fo... | async def _attempt_reconnect(self):
"""
Attempts to reconnect to the Lavalink server.
Returns
-------
bool
``True`` if the reconnection attempt was successful.
"""
log.info('Connection closed; attempting to reconnect in 30 seconds')
fo... | [
"Attempts",
"to",
"reconnect",
"to",
"the",
"Lavalink",
"server",
".",
"Returns",
"-------",
"bool",
"True",
"if",
"the",
"reconnection",
"attempt",
"was",
"successful",
"."
] | Devoxin/Lavalink.py | python | https://github.com/Devoxin/Lavalink.py/blob/63f55c3d726d24c4cfd3674d3cd6aab6f5be110d/lavalink/WebSocket.py#L75-L91 | [
"async",
"def",
"_attempt_reconnect",
"(",
"self",
")",
":",
"log",
".",
"info",
"(",
"'Connection closed; attempting to reconnect in 30 seconds'",
")",
"for",
"a",
"in",
"range",
"(",
"0",
",",
"self",
".",
"_ws_retry",
")",
":",
"await",
"asyncio",
".",
"sle... | 63f55c3d726d24c4cfd3674d3cd6aab6f5be110d |
valid | WebSocket.listen | Waits to receive a payload from the Lavalink server and processes it. | lavalink/WebSocket.py | async def listen(self):
""" Waits to receive a payload from the Lavalink server and processes it. """
while not self._shutdown:
try:
data = json.loads(await self._ws.recv())
except websockets.ConnectionClosed as error:
log.warning('Disconnect... | async def listen(self):
""" Waits to receive a payload from the Lavalink server and processes it. """
while not self._shutdown:
try:
data = json.loads(await self._ws.recv())
except websockets.ConnectionClosed as error:
log.warning('Disconnect... | [
"Waits",
"to",
"receive",
"a",
"payload",
"from",
"the",
"Lavalink",
"server",
"and",
"processes",
"it",
"."
] | Devoxin/Lavalink.py | python | https://github.com/Devoxin/Lavalink.py/blob/63f55c3d726d24c4cfd3674d3cd6aab6f5be110d/lavalink/WebSocket.py#L93-L142 | [
"async",
"def",
"listen",
"(",
"self",
")",
":",
"while",
"not",
"self",
".",
"_shutdown",
":",
"try",
":",
"data",
"=",
"json",
".",
"loads",
"(",
"await",
"self",
".",
"_ws",
".",
"recv",
"(",
")",
")",
"except",
"websockets",
".",
"ConnectionClose... | 63f55c3d726d24c4cfd3674d3cd6aab6f5be110d |
valid | DefaultPlayer.connected_channel | Returns the voice channel the player is connected to. | lavalink/PlayerManager.py | def connected_channel(self):
""" Returns the voice channel the player is connected to. """
if not self.channel_id:
return None
return self._lavalink.bot.get_channel(int(self.channel_id)) | def connected_channel(self):
""" Returns the voice channel the player is connected to. """
if not self.channel_id:
return None
return self._lavalink.bot.get_channel(int(self.channel_id)) | [
"Returns",
"the",
"voice",
"channel",
"the",
"player",
"is",
"connected",
"to",
"."
] | Devoxin/Lavalink.py | python | https://github.com/Devoxin/Lavalink.py/blob/63f55c3d726d24c4cfd3674d3cd6aab6f5be110d/lavalink/PlayerManager.py#L55-L60 | [
"def",
"connected_channel",
"(",
"self",
")",
":",
"if",
"not",
"self",
".",
"channel_id",
":",
"return",
"None",
"return",
"self",
".",
"_lavalink",
".",
"bot",
".",
"get_channel",
"(",
"int",
"(",
"self",
".",
"channel_id",
")",
")"
] | 63f55c3d726d24c4cfd3674d3cd6aab6f5be110d |
valid | DefaultPlayer.connect | Connects to a voice channel. | lavalink/PlayerManager.py | async def connect(self, channel_id: int):
""" Connects to a voice channel. """
ws = self._lavalink.bot._connection._get_websocket(int(self.guild_id))
await ws.voice_state(self.guild_id, str(channel_id)) | async def connect(self, channel_id: int):
""" Connects to a voice channel. """
ws = self._lavalink.bot._connection._get_websocket(int(self.guild_id))
await ws.voice_state(self.guild_id, str(channel_id)) | [
"Connects",
"to",
"a",
"voice",
"channel",
"."
] | Devoxin/Lavalink.py | python | https://github.com/Devoxin/Lavalink.py/blob/63f55c3d726d24c4cfd3674d3cd6aab6f5be110d/lavalink/PlayerManager.py#L62-L65 | [
"async",
"def",
"connect",
"(",
"self",
",",
"channel_id",
":",
"int",
")",
":",
"ws",
"=",
"self",
".",
"_lavalink",
".",
"bot",
".",
"_connection",
".",
"_get_websocket",
"(",
"int",
"(",
"self",
".",
"guild_id",
")",
")",
"await",
"ws",
".",
"voic... | 63f55c3d726d24c4cfd3674d3cd6aab6f5be110d |
valid | DefaultPlayer.disconnect | Disconnects from the voice channel, if any. | lavalink/PlayerManager.py | async def disconnect(self):
""" Disconnects from the voice channel, if any. """
if not self.is_connected:
return
await self.stop()
ws = self._lavalink.bot._connection._get_websocket(int(self.guild_id))
await ws.voice_state(self.guild_id, None) | async def disconnect(self):
""" Disconnects from the voice channel, if any. """
if not self.is_connected:
return
await self.stop()
ws = self._lavalink.bot._connection._get_websocket(int(self.guild_id))
await ws.voice_state(self.guild_id, None) | [
"Disconnects",
"from",
"the",
"voice",
"channel",
"if",
"any",
"."
] | Devoxin/Lavalink.py | python | https://github.com/Devoxin/Lavalink.py/blob/63f55c3d726d24c4cfd3674d3cd6aab6f5be110d/lavalink/PlayerManager.py#L67-L75 | [
"async",
"def",
"disconnect",
"(",
"self",
")",
":",
"if",
"not",
"self",
".",
"is_connected",
":",
"return",
"await",
"self",
".",
"stop",
"(",
")",
"ws",
"=",
"self",
".",
"_lavalink",
".",
"bot",
".",
"_connection",
".",
"_get_websocket",
"(",
"int"... | 63f55c3d726d24c4cfd3674d3cd6aab6f5be110d |
valid | DefaultPlayer.store | Stores custom user data. | lavalink/PlayerManager.py | def store(self, key: object, value: object):
""" Stores custom user data. """
self._user_data.update({key: value}) | def store(self, key: object, value: object):
""" Stores custom user data. """
self._user_data.update({key: value}) | [
"Stores",
"custom",
"user",
"data",
"."
] | Devoxin/Lavalink.py | python | https://github.com/Devoxin/Lavalink.py/blob/63f55c3d726d24c4cfd3674d3cd6aab6f5be110d/lavalink/PlayerManager.py#L77-L79 | [
"def",
"store",
"(",
"self",
",",
"key",
":",
"object",
",",
"value",
":",
"object",
")",
":",
"self",
".",
"_user_data",
".",
"update",
"(",
"{",
"key",
":",
"value",
"}",
")"
] | 63f55c3d726d24c4cfd3674d3cd6aab6f5be110d |
valid | DefaultPlayer.fetch | Retrieves the related value from the stored user data. | lavalink/PlayerManager.py | def fetch(self, key: object, default=None):
""" Retrieves the related value from the stored user data. """
return self._user_data.get(key, default) | def fetch(self, key: object, default=None):
""" Retrieves the related value from the stored user data. """
return self._user_data.get(key, default) | [
"Retrieves",
"the",
"related",
"value",
"from",
"the",
"stored",
"user",
"data",
"."
] | Devoxin/Lavalink.py | python | https://github.com/Devoxin/Lavalink.py/blob/63f55c3d726d24c4cfd3674d3cd6aab6f5be110d/lavalink/PlayerManager.py#L81-L83 | [
"def",
"fetch",
"(",
"self",
",",
"key",
":",
"object",
",",
"default",
"=",
"None",
")",
":",
"return",
"self",
".",
"_user_data",
".",
"get",
"(",
"key",
",",
"default",
")"
] | 63f55c3d726d24c4cfd3674d3cd6aab6f5be110d |
valid | DefaultPlayer.add | Adds a track to the queue. | lavalink/PlayerManager.py | def add(self, requester: int, track: dict):
""" Adds a track to the queue. """
self.queue.append(AudioTrack().build(track, requester)) | def add(self, requester: int, track: dict):
""" Adds a track to the queue. """
self.queue.append(AudioTrack().build(track, requester)) | [
"Adds",
"a",
"track",
"to",
"the",
"queue",
"."
] | Devoxin/Lavalink.py | python | https://github.com/Devoxin/Lavalink.py/blob/63f55c3d726d24c4cfd3674d3cd6aab6f5be110d/lavalink/PlayerManager.py#L92-L94 | [
"def",
"add",
"(",
"self",
",",
"requester",
":",
"int",
",",
"track",
":",
"dict",
")",
":",
"self",
".",
"queue",
".",
"append",
"(",
"AudioTrack",
"(",
")",
".",
"build",
"(",
"track",
",",
"requester",
")",
")"
] | 63f55c3d726d24c4cfd3674d3cd6aab6f5be110d |
valid | DefaultPlayer.add_next | Adds a track to beginning of the queue | lavalink/PlayerManager.py | def add_next(self, requester: int, track: dict):
""" Adds a track to beginning of the queue """
self.queue.insert(0, AudioTrack().build(track, requester)) | def add_next(self, requester: int, track: dict):
""" Adds a track to beginning of the queue """
self.queue.insert(0, AudioTrack().build(track, requester)) | [
"Adds",
"a",
"track",
"to",
"beginning",
"of",
"the",
"queue"
] | Devoxin/Lavalink.py | python | https://github.com/Devoxin/Lavalink.py/blob/63f55c3d726d24c4cfd3674d3cd6aab6f5be110d/lavalink/PlayerManager.py#L96-L98 | [
"def",
"add_next",
"(",
"self",
",",
"requester",
":",
"int",
",",
"track",
":",
"dict",
")",
":",
"self",
".",
"queue",
".",
"insert",
"(",
"0",
",",
"AudioTrack",
"(",
")",
".",
"build",
"(",
"track",
",",
"requester",
")",
")"
] | 63f55c3d726d24c4cfd3674d3cd6aab6f5be110d |
valid | DefaultPlayer.add_at | Adds a track at a specific index in the queue. | lavalink/PlayerManager.py | def add_at(self, index: int, requester: int, track: dict):
""" Adds a track at a specific index in the queue. """
self.queue.insert(min(index, len(self.queue) - 1), AudioTrack().build(track, requester)) | def add_at(self, index: int, requester: int, track: dict):
""" Adds a track at a specific index in the queue. """
self.queue.insert(min(index, len(self.queue) - 1), AudioTrack().build(track, requester)) | [
"Adds",
"a",
"track",
"at",
"a",
"specific",
"index",
"in",
"the",
"queue",
"."
] | Devoxin/Lavalink.py | python | https://github.com/Devoxin/Lavalink.py/blob/63f55c3d726d24c4cfd3674d3cd6aab6f5be110d/lavalink/PlayerManager.py#L100-L102 | [
"def",
"add_at",
"(",
"self",
",",
"index",
":",
"int",
",",
"requester",
":",
"int",
",",
"track",
":",
"dict",
")",
":",
"self",
".",
"queue",
".",
"insert",
"(",
"min",
"(",
"index",
",",
"len",
"(",
"self",
".",
"queue",
")",
"-",
"1",
")",... | 63f55c3d726d24c4cfd3674d3cd6aab6f5be110d |
valid | DefaultPlayer.play | Plays the first track in the queue, if any or plays a track from the specified index in the queue. | lavalink/PlayerManager.py | async def play(self, track_index: int = 0, ignore_shuffle: bool = False):
""" Plays the first track in the queue, if any or plays a track from the specified index in the queue. """
if self.repeat and self.current:
self.queue.append(self.current)
self.previous = self.current
... | async def play(self, track_index: int = 0, ignore_shuffle: bool = False):
""" Plays the first track in the queue, if any or plays a track from the specified index in the queue. """
if self.repeat and self.current:
self.queue.append(self.current)
self.previous = self.current
... | [
"Plays",
"the",
"first",
"track",
"in",
"the",
"queue",
"if",
"any",
"or",
"plays",
"a",
"track",
"from",
"the",
"specified",
"index",
"in",
"the",
"queue",
"."
] | Devoxin/Lavalink.py | python | https://github.com/Devoxin/Lavalink.py/blob/63f55c3d726d24c4cfd3674d3cd6aab6f5be110d/lavalink/PlayerManager.py#L104-L125 | [
"async",
"def",
"play",
"(",
"self",
",",
"track_index",
":",
"int",
"=",
"0",
",",
"ignore_shuffle",
":",
"bool",
"=",
"False",
")",
":",
"if",
"self",
".",
"repeat",
"and",
"self",
".",
"current",
":",
"self",
".",
"queue",
".",
"append",
"(",
"s... | 63f55c3d726d24c4cfd3674d3cd6aab6f5be110d |
valid | DefaultPlayer.play_now | Add track and play it. | lavalink/PlayerManager.py | async def play_now(self, requester: int, track: dict):
""" Add track and play it. """
self.add_next(requester, track)
await self.play(ignore_shuffle=True) | async def play_now(self, requester: int, track: dict):
""" Add track and play it. """
self.add_next(requester, track)
await self.play(ignore_shuffle=True) | [
"Add",
"track",
"and",
"play",
"it",
"."
] | Devoxin/Lavalink.py | python | https://github.com/Devoxin/Lavalink.py/blob/63f55c3d726d24c4cfd3674d3cd6aab6f5be110d/lavalink/PlayerManager.py#L127-L130 | [
"async",
"def",
"play_now",
"(",
"self",
",",
"requester",
":",
"int",
",",
"track",
":",
"dict",
")",
":",
"self",
".",
"add_next",
"(",
"requester",
",",
"track",
")",
"await",
"self",
".",
"play",
"(",
"ignore_shuffle",
"=",
"True",
")"
] | 63f55c3d726d24c4cfd3674d3cd6aab6f5be110d |
valid | DefaultPlayer.play_at | Play the queue from a specific point. Disregards tracks before the index. | lavalink/PlayerManager.py | async def play_at(self, index: int):
""" Play the queue from a specific point. Disregards tracks before the index. """
self.queue = self.queue[min(index, len(self.queue) - 1):len(self.queue)]
await self.play(ignore_shuffle=True) | async def play_at(self, index: int):
""" Play the queue from a specific point. Disregards tracks before the index. """
self.queue = self.queue[min(index, len(self.queue) - 1):len(self.queue)]
await self.play(ignore_shuffle=True) | [
"Play",
"the",
"queue",
"from",
"a",
"specific",
"point",
".",
"Disregards",
"tracks",
"before",
"the",
"index",
"."
] | Devoxin/Lavalink.py | python | https://github.com/Devoxin/Lavalink.py/blob/63f55c3d726d24c4cfd3674d3cd6aab6f5be110d/lavalink/PlayerManager.py#L132-L135 | [
"async",
"def",
"play_at",
"(",
"self",
",",
"index",
":",
"int",
")",
":",
"self",
".",
"queue",
"=",
"self",
".",
"queue",
"[",
"min",
"(",
"index",
",",
"len",
"(",
"self",
".",
"queue",
")",
"-",
"1",
")",
":",
"len",
"(",
"self",
".",
"q... | 63f55c3d726d24c4cfd3674d3cd6aab6f5be110d |
valid | DefaultPlayer.play_previous | Plays previous track if it exist, if it doesn't raises a NoPreviousTrack error. | lavalink/PlayerManager.py | async def play_previous(self):
""" Plays previous track if it exist, if it doesn't raises a NoPreviousTrack error. """
if not self.previous:
raise NoPreviousTrack
self.queue.insert(0, self.previous)
await self.play(ignore_shuffle=True) | async def play_previous(self):
""" Plays previous track if it exist, if it doesn't raises a NoPreviousTrack error. """
if not self.previous:
raise NoPreviousTrack
self.queue.insert(0, self.previous)
await self.play(ignore_shuffle=True) | [
"Plays",
"previous",
"track",
"if",
"it",
"exist",
"if",
"it",
"doesn",
"t",
"raises",
"a",
"NoPreviousTrack",
"error",
"."
] | Devoxin/Lavalink.py | python | https://github.com/Devoxin/Lavalink.py/blob/63f55c3d726d24c4cfd3674d3cd6aab6f5be110d/lavalink/PlayerManager.py#L137-L142 | [
"async",
"def",
"play_previous",
"(",
"self",
")",
":",
"if",
"not",
"self",
".",
"previous",
":",
"raise",
"NoPreviousTrack",
"self",
".",
"queue",
".",
"insert",
"(",
"0",
",",
"self",
".",
"previous",
")",
"await",
"self",
".",
"play",
"(",
"ignore_... | 63f55c3d726d24c4cfd3674d3cd6aab6f5be110d |
valid | DefaultPlayer.stop | Stops the player, if playing. | lavalink/PlayerManager.py | async def stop(self):
""" Stops the player, if playing. """
await self._lavalink.ws.send(op='stop', guildId=self.guild_id)
self.current = None | async def stop(self):
""" Stops the player, if playing. """
await self._lavalink.ws.send(op='stop', guildId=self.guild_id)
self.current = None | [
"Stops",
"the",
"player",
"if",
"playing",
"."
] | Devoxin/Lavalink.py | python | https://github.com/Devoxin/Lavalink.py/blob/63f55c3d726d24c4cfd3674d3cd6aab6f5be110d/lavalink/PlayerManager.py#L144-L147 | [
"async",
"def",
"stop",
"(",
"self",
")",
":",
"await",
"self",
".",
"_lavalink",
".",
"ws",
".",
"send",
"(",
"op",
"=",
"'stop'",
",",
"guildId",
"=",
"self",
".",
"guild_id",
")",
"self",
".",
"current",
"=",
"None"
] | 63f55c3d726d24c4cfd3674d3cd6aab6f5be110d |
valid | DefaultPlayer.set_pause | Sets the player's paused state. | lavalink/PlayerManager.py | async def set_pause(self, pause: bool):
""" Sets the player's paused state. """
await self._lavalink.ws.send(op='pause', guildId=self.guild_id, pause=pause)
self.paused = pause | async def set_pause(self, pause: bool):
""" Sets the player's paused state. """
await self._lavalink.ws.send(op='pause', guildId=self.guild_id, pause=pause)
self.paused = pause | [
"Sets",
"the",
"player",
"s",
"paused",
"state",
"."
] | Devoxin/Lavalink.py | python | https://github.com/Devoxin/Lavalink.py/blob/63f55c3d726d24c4cfd3674d3cd6aab6f5be110d/lavalink/PlayerManager.py#L153-L156 | [
"async",
"def",
"set_pause",
"(",
"self",
",",
"pause",
":",
"bool",
")",
":",
"await",
"self",
".",
"_lavalink",
".",
"ws",
".",
"send",
"(",
"op",
"=",
"'pause'",
",",
"guildId",
"=",
"self",
".",
"guild_id",
",",
"pause",
"=",
"pause",
")",
"sel... | 63f55c3d726d24c4cfd3674d3cd6aab6f5be110d |
valid | DefaultPlayer.set_volume | Sets the player's volume (150% or 1000% limit imposed by lavalink depending on the version). | lavalink/PlayerManager.py | async def set_volume(self, vol: int):
""" Sets the player's volume (150% or 1000% limit imposed by lavalink depending on the version). """
if self._lavalink._server_version <= 2:
self.volume = max(min(vol, 150), 0)
else:
self.volume = max(min(vol, 1000), 0)
... | async def set_volume(self, vol: int):
""" Sets the player's volume (150% or 1000% limit imposed by lavalink depending on the version). """
if self._lavalink._server_version <= 2:
self.volume = max(min(vol, 150), 0)
else:
self.volume = max(min(vol, 1000), 0)
... | [
"Sets",
"the",
"player",
"s",
"volume",
"(",
"150%",
"or",
"1000%",
"limit",
"imposed",
"by",
"lavalink",
"depending",
"on",
"the",
"version",
")",
"."
] | Devoxin/Lavalink.py | python | https://github.com/Devoxin/Lavalink.py/blob/63f55c3d726d24c4cfd3674d3cd6aab6f5be110d/lavalink/PlayerManager.py#L158-L164 | [
"async",
"def",
"set_volume",
"(",
"self",
",",
"vol",
":",
"int",
")",
":",
"if",
"self",
".",
"_lavalink",
".",
"_server_version",
"<=",
"2",
":",
"self",
".",
"volume",
"=",
"max",
"(",
"min",
"(",
"vol",
",",
"150",
")",
",",
"0",
")",
"else"... | 63f55c3d726d24c4cfd3674d3cd6aab6f5be110d |
valid | DefaultPlayer.seek | Seeks to a given position in the track. | lavalink/PlayerManager.py | async def seek(self, pos: int):
""" Seeks to a given position in the track. """
await self._lavalink.ws.send(op='seek', guildId=self.guild_id, position=pos) | async def seek(self, pos: int):
""" Seeks to a given position in the track. """
await self._lavalink.ws.send(op='seek', guildId=self.guild_id, position=pos) | [
"Seeks",
"to",
"a",
"given",
"position",
"in",
"the",
"track",
"."
] | Devoxin/Lavalink.py | python | https://github.com/Devoxin/Lavalink.py/blob/63f55c3d726d24c4cfd3674d3cd6aab6f5be110d/lavalink/PlayerManager.py#L166-L168 | [
"async",
"def",
"seek",
"(",
"self",
",",
"pos",
":",
"int",
")",
":",
"await",
"self",
".",
"_lavalink",
".",
"ws",
".",
"send",
"(",
"op",
"=",
"'seek'",
",",
"guildId",
"=",
"self",
".",
"guild_id",
",",
"position",
"=",
"pos",
")"
] | 63f55c3d726d24c4cfd3674d3cd6aab6f5be110d |
valid | DefaultPlayer.handle_event | Makes the player play the next song from the queue if a song has finished or an issue occurred. | lavalink/PlayerManager.py | async def handle_event(self, event):
""" Makes the player play the next song from the queue if a song has finished or an issue occurred. """
if isinstance(event, (TrackStuckEvent, TrackExceptionEvent)) or \
isinstance(event, TrackEndEvent) and event.reason == 'FINISHED':
... | async def handle_event(self, event):
""" Makes the player play the next song from the queue if a song has finished or an issue occurred. """
if isinstance(event, (TrackStuckEvent, TrackExceptionEvent)) or \
isinstance(event, TrackEndEvent) and event.reason == 'FINISHED':
... | [
"Makes",
"the",
"player",
"play",
"the",
"next",
"song",
"from",
"the",
"queue",
"if",
"a",
"song",
"has",
"finished",
"or",
"an",
"issue",
"occurred",
"."
] | Devoxin/Lavalink.py | python | https://github.com/Devoxin/Lavalink.py/blob/63f55c3d726d24c4cfd3674d3cd6aab6f5be110d/lavalink/PlayerManager.py#L170-L174 | [
"async",
"def",
"handle_event",
"(",
"self",
",",
"event",
")",
":",
"if",
"isinstance",
"(",
"event",
",",
"(",
"TrackStuckEvent",
",",
"TrackExceptionEvent",
")",
")",
"or",
"isinstance",
"(",
"event",
",",
"TrackEndEvent",
")",
"and",
"event",
".",
"rea... | 63f55c3d726d24c4cfd3674d3cd6aab6f5be110d |
valid | PlayerManager.get | Returns a player from the cache, or creates one if it does not exist. | lavalink/PlayerManager.py | def get(self, guild_id):
""" Returns a player from the cache, or creates one if it does not exist. """
if guild_id not in self._players:
p = self._player(lavalink=self.lavalink, guild_id=guild_id)
self._players[guild_id] = p
return self._players[guild_id] | def get(self, guild_id):
""" Returns a player from the cache, or creates one if it does not exist. """
if guild_id not in self._players:
p = self._player(lavalink=self.lavalink, guild_id=guild_id)
self._players[guild_id] = p
return self._players[guild_id] | [
"Returns",
"a",
"player",
"from",
"the",
"cache",
"or",
"creates",
"one",
"if",
"it",
"does",
"not",
"exist",
"."
] | Devoxin/Lavalink.py | python | https://github.com/Devoxin/Lavalink.py/blob/63f55c3d726d24c4cfd3674d3cd6aab6f5be110d/lavalink/PlayerManager.py#L218-L224 | [
"def",
"get",
"(",
"self",
",",
"guild_id",
")",
":",
"if",
"guild_id",
"not",
"in",
"self",
".",
"_players",
":",
"p",
"=",
"self",
".",
"_player",
"(",
"lavalink",
"=",
"self",
".",
"lavalink",
",",
"guild_id",
"=",
"guild_id",
")",
"self",
".",
... | 63f55c3d726d24c4cfd3674d3cd6aab6f5be110d |
valid | PlayerManager.remove | Removes a player from the current players. | lavalink/PlayerManager.py | def remove(self, guild_id):
""" Removes a player from the current players. """
if guild_id in self._players:
self._players[guild_id].cleanup()
del self._players[guild_id] | def remove(self, guild_id):
""" Removes a player from the current players. """
if guild_id in self._players:
self._players[guild_id].cleanup()
del self._players[guild_id] | [
"Removes",
"a",
"player",
"from",
"the",
"current",
"players",
"."
] | Devoxin/Lavalink.py | python | https://github.com/Devoxin/Lavalink.py/blob/63f55c3d726d24c4cfd3674d3cd6aab6f5be110d/lavalink/PlayerManager.py#L226-L230 | [
"def",
"remove",
"(",
"self",
",",
"guild_id",
")",
":",
"if",
"guild_id",
"in",
"self",
".",
"_players",
":",
"self",
".",
"_players",
"[",
"guild_id",
"]",
".",
"cleanup",
"(",
")",
"del",
"self",
".",
"_players",
"[",
"guild_id",
"]"
] | 63f55c3d726d24c4cfd3674d3cd6aab6f5be110d |
valid | Music._play | Searches and plays a song from a given query. | examples/music-v2.py | async def _play(self, ctx, *, query: str):
""" Searches and plays a song from a given query. """
player = self.bot.lavalink.players.get(ctx.guild.id)
query = query.strip('<>')
if not url_rx.match(query):
query = f'ytsearch:{query}'
tracks = await self.bot.... | async def _play(self, ctx, *, query: str):
""" Searches and plays a song from a given query. """
player = self.bot.lavalink.players.get(ctx.guild.id)
query = query.strip('<>')
if not url_rx.match(query):
query = f'ytsearch:{query}'
tracks = await self.bot.... | [
"Searches",
"and",
"plays",
"a",
"song",
"from",
"a",
"given",
"query",
"."
] | Devoxin/Lavalink.py | python | https://github.com/Devoxin/Lavalink.py/blob/63f55c3d726d24c4cfd3674d3cd6aab6f5be110d/examples/music-v2.py#L55-L87 | [
"async",
"def",
"_play",
"(",
"self",
",",
"ctx",
",",
"*",
",",
"query",
":",
"str",
")",
":",
"player",
"=",
"self",
".",
"bot",
".",
"lavalink",
".",
"players",
".",
"get",
"(",
"ctx",
".",
"guild",
".",
"id",
")",
"query",
"=",
"query",
"."... | 63f55c3d726d24c4cfd3674d3cd6aab6f5be110d |
valid | Music._seek | Seeks to a given position in a track. | examples/music-v2.py | async def _seek(self, ctx, *, time: str):
""" Seeks to a given position in a track. """
player = self.bot.lavalink.players.get(ctx.guild.id)
if not player.is_playing:
return await ctx.send('Not playing.')
seconds = time_rx.search(time)
if not seconds:
... | async def _seek(self, ctx, *, time: str):
""" Seeks to a given position in a track. """
player = self.bot.lavalink.players.get(ctx.guild.id)
if not player.is_playing:
return await ctx.send('Not playing.')
seconds = time_rx.search(time)
if not seconds:
... | [
"Seeks",
"to",
"a",
"given",
"position",
"in",
"a",
"track",
"."
] | Devoxin/Lavalink.py | python | https://github.com/Devoxin/Lavalink.py/blob/63f55c3d726d24c4cfd3674d3cd6aab6f5be110d/examples/music-v2.py#L91-L109 | [
"async",
"def",
"_seek",
"(",
"self",
",",
"ctx",
",",
"*",
",",
"time",
":",
"str",
")",
":",
"player",
"=",
"self",
".",
"bot",
".",
"lavalink",
".",
"players",
".",
"get",
"(",
"ctx",
".",
"guild",
".",
"id",
")",
"if",
"not",
"player",
".",... | 63f55c3d726d24c4cfd3674d3cd6aab6f5be110d |
valid | Music._skip | Skips the current track. | examples/music-v2.py | async def _skip(self, ctx):
""" Skips the current track. """
player = self.bot.lavalink.players.get(ctx.guild.id)
if not player.is_playing:
return await ctx.send('Not playing.')
await player.skip()
await ctx.send('⏭ | Skipped.') | async def _skip(self, ctx):
""" Skips the current track. """
player = self.bot.lavalink.players.get(ctx.guild.id)
if not player.is_playing:
return await ctx.send('Not playing.')
await player.skip()
await ctx.send('⏭ | Skipped.') | [
"Skips",
"the",
"current",
"track",
"."
] | Devoxin/Lavalink.py | python | https://github.com/Devoxin/Lavalink.py/blob/63f55c3d726d24c4cfd3674d3cd6aab6f5be110d/examples/music-v2.py#L113-L121 | [
"async",
"def",
"_skip",
"(",
"self",
",",
"ctx",
")",
":",
"player",
"=",
"self",
".",
"bot",
".",
"lavalink",
".",
"players",
".",
"get",
"(",
"ctx",
".",
"guild",
".",
"id",
")",
"if",
"not",
"player",
".",
"is_playing",
":",
"return",
"await",
... | 63f55c3d726d24c4cfd3674d3cd6aab6f5be110d |
valid | Music._stop | Stops the player and clears its queue. | examples/music-v2.py | async def _stop(self, ctx):
""" Stops the player and clears its queue. """
player = self.bot.lavalink.players.get(ctx.guild.id)
if not player.is_playing:
return await ctx.send('Not playing.')
player.queue.clear()
await player.stop()
await ctx.send('... | async def _stop(self, ctx):
""" Stops the player and clears its queue. """
player = self.bot.lavalink.players.get(ctx.guild.id)
if not player.is_playing:
return await ctx.send('Not playing.')
player.queue.clear()
await player.stop()
await ctx.send('... | [
"Stops",
"the",
"player",
"and",
"clears",
"its",
"queue",
"."
] | Devoxin/Lavalink.py | python | https://github.com/Devoxin/Lavalink.py/blob/63f55c3d726d24c4cfd3674d3cd6aab6f5be110d/examples/music-v2.py#L125-L134 | [
"async",
"def",
"_stop",
"(",
"self",
",",
"ctx",
")",
":",
"player",
"=",
"self",
".",
"bot",
".",
"lavalink",
".",
"players",
".",
"get",
"(",
"ctx",
".",
"guild",
".",
"id",
")",
"if",
"not",
"player",
".",
"is_playing",
":",
"return",
"await",
... | 63f55c3d726d24c4cfd3674d3cd6aab6f5be110d |
valid | Music._now | Shows some stats about the currently playing song. | examples/music-v2.py | async def _now(self, ctx):
""" Shows some stats about the currently playing song. """
player = self.bot.lavalink.players.get(ctx.guild.id)
song = 'Nothing'
if player.current:
position = lavalink.Utils.format_time(player.position)
if player.current.stream:
... | async def _now(self, ctx):
""" Shows some stats about the currently playing song. """
player = self.bot.lavalink.players.get(ctx.guild.id)
song = 'Nothing'
if player.current:
position = lavalink.Utils.format_time(player.position)
if player.current.stream:
... | [
"Shows",
"some",
"stats",
"about",
"the",
"currently",
"playing",
"song",
"."
] | Devoxin/Lavalink.py | python | https://github.com/Devoxin/Lavalink.py/blob/63f55c3d726d24c4cfd3674d3cd6aab6f5be110d/examples/music-v2.py#L138-L152 | [
"async",
"def",
"_now",
"(",
"self",
",",
"ctx",
")",
":",
"player",
"=",
"self",
".",
"bot",
".",
"lavalink",
".",
"players",
".",
"get",
"(",
"ctx",
".",
"guild",
".",
"id",
")",
"song",
"=",
"'Nothing'",
"if",
"player",
".",
"current",
":",
"p... | 63f55c3d726d24c4cfd3674d3cd6aab6f5be110d |
valid | Music._queue | Shows the player's queue. | examples/music-v2.py | async def _queue(self, ctx, page: int = 1):
""" Shows the player's queue. """
player = self.bot.lavalink.players.get(ctx.guild.id)
if not player.queue:
return await ctx.send('There\'s nothing in the queue! Why not queue something?')
items_per_page = 10
pages... | async def _queue(self, ctx, page: int = 1):
""" Shows the player's queue. """
player = self.bot.lavalink.players.get(ctx.guild.id)
if not player.queue:
return await ctx.send('There\'s nothing in the queue! Why not queue something?')
items_per_page = 10
pages... | [
"Shows",
"the",
"player",
"s",
"queue",
"."
] | Devoxin/Lavalink.py | python | https://github.com/Devoxin/Lavalink.py/blob/63f55c3d726d24c4cfd3674d3cd6aab6f5be110d/examples/music-v2.py#L156-L176 | [
"async",
"def",
"_queue",
"(",
"self",
",",
"ctx",
",",
"page",
":",
"int",
"=",
"1",
")",
":",
"player",
"=",
"self",
".",
"bot",
".",
"lavalink",
".",
"players",
".",
"get",
"(",
"ctx",
".",
"guild",
".",
"id",
")",
"if",
"not",
"player",
"."... | 63f55c3d726d24c4cfd3674d3cd6aab6f5be110d |
valid | Music._pause | Pauses/Resumes the current track. | examples/music-v2.py | async def _pause(self, ctx):
""" Pauses/Resumes the current track. """
player = self.bot.lavalink.players.get(ctx.guild.id)
if not player.is_playing:
return await ctx.send('Not playing.')
if player.paused:
await player.set_pause(False)
await... | async def _pause(self, ctx):
""" Pauses/Resumes the current track. """
player = self.bot.lavalink.players.get(ctx.guild.id)
if not player.is_playing:
return await ctx.send('Not playing.')
if player.paused:
await player.set_pause(False)
await... | [
"Pauses",
"/",
"Resumes",
"the",
"current",
"track",
"."
] | Devoxin/Lavalink.py | python | https://github.com/Devoxin/Lavalink.py/blob/63f55c3d726d24c4cfd3674d3cd6aab6f5be110d/examples/music-v2.py#L180-L192 | [
"async",
"def",
"_pause",
"(",
"self",
",",
"ctx",
")",
":",
"player",
"=",
"self",
".",
"bot",
".",
"lavalink",
".",
"players",
".",
"get",
"(",
"ctx",
".",
"guild",
".",
"id",
")",
"if",
"not",
"player",
".",
"is_playing",
":",
"return",
"await",... | 63f55c3d726d24c4cfd3674d3cd6aab6f5be110d |
valid | Music._volume | Changes the player's volume. Must be between 0 and 150. Error Handling for that is done by Lavalink. | examples/music-v2.py | async def _volume(self, ctx, volume: int = None):
""" Changes the player's volume. Must be between 0 and 150. Error Handling for that is done by Lavalink. """
player = self.bot.lavalink.players.get(ctx.guild.id)
if not volume:
return await ctx.send(f'🔈 | {player.volume}%')
... | async def _volume(self, ctx, volume: int = None):
""" Changes the player's volume. Must be between 0 and 150. Error Handling for that is done by Lavalink. """
player = self.bot.lavalink.players.get(ctx.guild.id)
if not volume:
return await ctx.send(f'🔈 | {player.volume}%')
... | [
"Changes",
"the",
"player",
"s",
"volume",
".",
"Must",
"be",
"between",
"0",
"and",
"150",
".",
"Error",
"Handling",
"for",
"that",
"is",
"done",
"by",
"Lavalink",
"."
] | Devoxin/Lavalink.py | python | https://github.com/Devoxin/Lavalink.py/blob/63f55c3d726d24c4cfd3674d3cd6aab6f5be110d/examples/music-v2.py#L196-L204 | [
"async",
"def",
"_volume",
"(",
"self",
",",
"ctx",
",",
"volume",
":",
"int",
"=",
"None",
")",
":",
"player",
"=",
"self",
".",
"bot",
".",
"lavalink",
".",
"players",
".",
"get",
"(",
"ctx",
".",
"guild",
".",
"id",
")",
"if",
"not",
"volume",... | 63f55c3d726d24c4cfd3674d3cd6aab6f5be110d |
valid | Music._shuffle | Shuffles the player's queue. | examples/music-v2.py | async def _shuffle(self, ctx):
""" Shuffles the player's queue. """
player = self.bot.lavalink.players.get(ctx.guild.id)
if not player.is_playing:
return await ctx.send('Nothing playing.')
player.shuffle = not player.shuffle
await ctx.send('🔀 | Shuffle ' + ... | async def _shuffle(self, ctx):
""" Shuffles the player's queue. """
player = self.bot.lavalink.players.get(ctx.guild.id)
if not player.is_playing:
return await ctx.send('Nothing playing.')
player.shuffle = not player.shuffle
await ctx.send('🔀 | Shuffle ' + ... | [
"Shuffles",
"the",
"player",
"s",
"queue",
"."
] | Devoxin/Lavalink.py | python | https://github.com/Devoxin/Lavalink.py/blob/63f55c3d726d24c4cfd3674d3cd6aab6f5be110d/examples/music-v2.py#L208-L216 | [
"async",
"def",
"_shuffle",
"(",
"self",
",",
"ctx",
")",
":",
"player",
"=",
"self",
".",
"bot",
".",
"lavalink",
".",
"players",
".",
"get",
"(",
"ctx",
".",
"guild",
".",
"id",
")",
"if",
"not",
"player",
".",
"is_playing",
":",
"return",
"await... | 63f55c3d726d24c4cfd3674d3cd6aab6f5be110d |
valid | Music._repeat | Repeats the current song until the command is invoked again. | examples/music-v2.py | async def _repeat(self, ctx):
""" Repeats the current song until the command is invoked again. """
player = self.bot.lavalink.players.get(ctx.guild.id)
if not player.is_playing:
return await ctx.send('Nothing playing.')
player.repeat = not player.repeat
awai... | async def _repeat(self, ctx):
""" Repeats the current song until the command is invoked again. """
player = self.bot.lavalink.players.get(ctx.guild.id)
if not player.is_playing:
return await ctx.send('Nothing playing.')
player.repeat = not player.repeat
awai... | [
"Repeats",
"the",
"current",
"song",
"until",
"the",
"command",
"is",
"invoked",
"again",
"."
] | Devoxin/Lavalink.py | python | https://github.com/Devoxin/Lavalink.py/blob/63f55c3d726d24c4cfd3674d3cd6aab6f5be110d/examples/music-v2.py#L220-L228 | [
"async",
"def",
"_repeat",
"(",
"self",
",",
"ctx",
")",
":",
"player",
"=",
"self",
".",
"bot",
".",
"lavalink",
".",
"players",
".",
"get",
"(",
"ctx",
".",
"guild",
".",
"id",
")",
"if",
"not",
"player",
".",
"is_playing",
":",
"return",
"await"... | 63f55c3d726d24c4cfd3674d3cd6aab6f5be110d |
valid | Music._remove | Removes an item from the player's queue with the given index. | examples/music-v2.py | async def _remove(self, ctx, index: int):
""" Removes an item from the player's queue with the given index. """
player = self.bot.lavalink.players.get(ctx.guild.id)
if not player.queue:
return await ctx.send('Nothing queued.')
if index > len(player.queue) or index < ... | async def _remove(self, ctx, index: int):
""" Removes an item from the player's queue with the given index. """
player = self.bot.lavalink.players.get(ctx.guild.id)
if not player.queue:
return await ctx.send('Nothing queued.')
if index > len(player.queue) or index < ... | [
"Removes",
"an",
"item",
"from",
"the",
"player",
"s",
"queue",
"with",
"the",
"given",
"index",
"."
] | Devoxin/Lavalink.py | python | https://github.com/Devoxin/Lavalink.py/blob/63f55c3d726d24c4cfd3674d3cd6aab6f5be110d/examples/music-v2.py#L232-L245 | [
"async",
"def",
"_remove",
"(",
"self",
",",
"ctx",
",",
"index",
":",
"int",
")",
":",
"player",
"=",
"self",
".",
"bot",
".",
"lavalink",
".",
"players",
".",
"get",
"(",
"ctx",
".",
"guild",
".",
"id",
")",
"if",
"not",
"player",
".",
"queue",... | 63f55c3d726d24c4cfd3674d3cd6aab6f5be110d |
valid | Music._disconnect | Disconnects the player from the voice channel and clears its queue. | examples/music-v2.py | async def _disconnect(self, ctx):
""" Disconnects the player from the voice channel and clears its queue. """
player = self.bot.lavalink.players.get(ctx.guild.id)
if not player.is_connected:
return await ctx.send('Not connected.')
if not ctx.author.voice or (player.i... | async def _disconnect(self, ctx):
""" Disconnects the player from the voice channel and clears its queue. """
player = self.bot.lavalink.players.get(ctx.guild.id)
if not player.is_connected:
return await ctx.send('Not connected.')
if not ctx.author.voice or (player.i... | [
"Disconnects",
"the",
"player",
"from",
"the",
"voice",
"channel",
"and",
"clears",
"its",
"queue",
"."
] | Devoxin/Lavalink.py | python | https://github.com/Devoxin/Lavalink.py/blob/63f55c3d726d24c4cfd3674d3cd6aab6f5be110d/examples/music-v2.py#L273-L285 | [
"async",
"def",
"_disconnect",
"(",
"self",
",",
"ctx",
")",
":",
"player",
"=",
"self",
".",
"bot",
".",
"lavalink",
".",
"players",
".",
"get",
"(",
"ctx",
".",
"guild",
".",
"id",
")",
"if",
"not",
"player",
".",
"is_connected",
":",
"return",
"... | 63f55c3d726d24c4cfd3674d3cd6aab6f5be110d |
valid | Music.ensure_voice | A few checks to make sure the bot can join a voice channel. | examples/music-v2.py | async def ensure_voice(self, ctx):
""" A few checks to make sure the bot can join a voice channel. """
player = self.bot.lavalink.players.get(ctx.guild.id)
if not player.is_connected:
if not ctx.author.voice or not ctx.author.voice.channel:
await ctx.send('You ... | async def ensure_voice(self, ctx):
""" A few checks to make sure the bot can join a voice channel. """
player = self.bot.lavalink.players.get(ctx.guild.id)
if not player.is_connected:
if not ctx.author.voice or not ctx.author.voice.channel:
await ctx.send('You ... | [
"A",
"few",
"checks",
"to",
"make",
"sure",
"the",
"bot",
"can",
"join",
"a",
"voice",
"channel",
"."
] | Devoxin/Lavalink.py | python | https://github.com/Devoxin/Lavalink.py/blob/63f55c3d726d24c4cfd3674d3cd6aab6f5be110d/examples/music-v2.py#L288-L307 | [
"async",
"def",
"ensure_voice",
"(",
"self",
",",
"ctx",
")",
":",
"player",
"=",
"self",
".",
"bot",
".",
"lavalink",
".",
"players",
".",
"get",
"(",
"ctx",
".",
"guild",
".",
"id",
")",
"if",
"not",
"player",
".",
"is_connected",
":",
"if",
"not... | 63f55c3d726d24c4cfd3674d3cd6aab6f5be110d |
valid | Client.register_hook | Registers a hook. Since this probably is a bit difficult, I'll explain it in detail.
A hook basically is an object of a function you pass. This will append that object to a list and whenever
an event from the Lavalink server is dispatched, the function will be called internally. For declaring the
... | lavalink/Client.py | def register_hook(self, func):
"""
Registers a hook. Since this probably is a bit difficult, I'll explain it in detail.
A hook basically is an object of a function you pass. This will append that object to a list and whenever
an event from the Lavalink server is dispatched, the funct... | def register_hook(self, func):
"""
Registers a hook. Since this probably is a bit difficult, I'll explain it in detail.
A hook basically is an object of a function you pass. This will append that object to a list and whenever
an event from the Lavalink server is dispatched, the funct... | [
"Registers",
"a",
"hook",
".",
"Since",
"this",
"probably",
"is",
"a",
"bit",
"difficult",
"I",
"ll",
"explain",
"it",
"in",
"detail",
".",
"A",
"hook",
"basically",
"is",
"an",
"object",
"of",
"a",
"function",
"you",
"pass",
".",
"This",
"will",
"appe... | Devoxin/Lavalink.py | python | https://github.com/Devoxin/Lavalink.py/blob/63f55c3d726d24c4cfd3674d3cd6aab6f5be110d/lavalink/Client.py#L71-L98 | [
"def",
"register_hook",
"(",
"self",
",",
"func",
")",
":",
"if",
"func",
"not",
"in",
"self",
".",
"hooks",
":",
"self",
".",
"hooks",
".",
"append",
"(",
"func",
")"
] | 63f55c3d726d24c4cfd3674d3cd6aab6f5be110d |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.