INSTRUCTION stringlengths 1 8.43k | RESPONSE stringlengths 75 104k |
|---|---|
Converts the text category to a tasks. Category instance. | def parse_category(self, item, field_name, source_name):
"""
Converts the text category to a tasks.Category instance.
"""
# Get and checks for the corresponding slug
slug = category_map.get(self.get_value(item, source_name), None)
if not slug:
return None
... |
Converts the date in the format: Thu 03. | def parse_date(self, item, field_name, source_name):
"""
Converts the date in the format: Thu 03.
As only the day is provided, tries to find the best match
based on the current date, considering that dates are on
the past.
"""
# Get the current date
now =... |
Parse numeric fields. | def parse_totals(self, item, field_name, source_name):
"""
Parse numeric fields.
"""
val = self.get_value(item, source_name)
try:
return int(val)
except:
return 0 |
Iterator of the list of items in the XML source. | def get_items(self):
"""
Iterator of the list of items in the XML source.
"""
# Use `iterparse`, it's more efficient, specially for big files
for event, item in ElementTree.iterparse(self.source):
if item.tag == self.item_tag_name:
yield item
... |
This method receives an item from the source and a source name and returns the text content for the source_name node. | def get_value(self, item, source_name):
"""
This method receives an item from the source and a source name,
and returns the text content for the `source_name` node.
"""
return force_text(smart_str(item.findtext(source_name))).strip() |
Saves an error in the error list. | def save_error(self, data, exception_info):
"""
Saves an error in the error list.
"""
# TODO: what to do with errors? Let it flow? Write to a log file?
self.errors.append({'data': data,
'exception': ''.join(format_exception(*exception_info)),
... |
Parses all data from the source saving model instances. | def parse(self):
"""
Parses all data from the source, saving model instances.
"""
# Checks if the source is loaded
if not self.loaded:
self.load(self.source)
for item in self.get_items():
# Parse the fields from the source into a dict
... |
Receives an item and returns a dictionary of field values. | def parse_item(self, item):
"""
Receives an item and returns a dictionary of field values.
"""
# Create a dictionary from values for each field
parsed_data = {}
for field_name in self.fields:
# A field-name may be mapped to another identifier on the s... |
Get an item from the database or an empty one if not found. | def get_instance(self, data):
"""
Get an item from the database or an empty one if not found.
"""
# Get unique fields
unique_fields = self.unique_fields
# If there are no unique fields option, all items are new
if not unique_fields:
return sel... |
Feeds a model instance using parsed data ( usually from parse_item ). | def feed_instance(self, data, instance):
"""
Feeds a model instance using parsed data (usually from `parse_item`).
"""
for prop, val in data.items():
setattr(instance, prop, val)
return instance |
Saves a model instance to the database. | def save_item(self, item, data, instance, commit=True):
"""
Saves a model instance to the database.
"""
if commit:
instance.save()
return instance |
Downloads a HTTP resource from url and save to dest. Capable of dealing with Gzip compressed content. | def download_file(url, dest):
"""
Downloads a HTTP resource from `url` and save to `dest`.
Capable of dealing with Gzip compressed content.
"""
# Create the HTTP request
request = urllib2.Request(url)
# Add the header to accept gzip encoding
request.add_header('Accept-enco... |
Opens the source file. | def load(self, source):
"""
Opens the source file.
"""
self.source = open(self.source, 'rb')
self.loaded = True |
Iterator to read the rows of the CSV file. | def get_items(self):
"""
Iterator to read the rows of the CSV file.
"""
# Get the csv reader
reader = csv.reader(self.source)
# Get the headers from the first line
headers = reader.next()
# Read each line yielding a dictionary mapping
# the column ... |
This method receives an item from the source and a source name and returns the text content for the source_name node. | def get_value(self, item, source_name):
"""
This method receives an item from the source and a source name,
and returns the text content for the `source_name` node.
"""
val = item.get(source_name.encode('utf-8'), None)
if val is not None:
val = convert_string(... |
Return value of variable set in the package where said variable is named in the Python meta format __<meta_name > __. | def get_package_meta(meta_name):
"""Return value of variable set in the package where said variable is
named in the Python meta format `__<meta_name>__`.
"""
regex = "__{0}__ = ['\"]([^'\"]+)['\"]".format(meta_name)
return re.search(regex, package_file).group(1) |
Raises ValueError if this sandbox instance is currently running. | def allow_network_access(self, value: bool):
"""
Raises ValueError if this sandbox instance is currently running.
"""
if self._is_running:
raise ValueError(
"Cannot change network access settings on a running sandbox")
self._allow_network_access = val... |
Runs a command inside the sandbox and returns the results. | def run_command(self,
args: List[str],
max_num_processes: int=None,
max_stack_size: int=None,
max_virtual_memory: int=None,
as_root: bool=False,
stdin: FileIO=None,
timeout: int=No... |
Copies the specified files into the working directory of this sandbox. The filenames specified can be absolute paths or relative paths to the current working directory. | def add_files(self, *filenames: str, owner: str=SANDBOX_USERNAME, read_only: bool=False):
"""
Copies the specified files into the working directory of this
sandbox.
The filenames specified can be absolute paths or relative paths
to the current working directory.
:param o... |
Copies the specified file into the working directory of this sandbox and renames it to new_filename. | def add_and_rename_file(self, filename: str, new_filename: str) -> None:
"""
Copies the specified file into the working directory of this
sandbox and renames it to new_filename.
"""
dest = os.path.join(
self.name + ':' + SANDBOX_WORKING_DIR_NAME,
new_filen... |
Return a list of all enrollments for the passed course_id. | def get_enrollments_for_course(self, course_id, params={}):
"""
Return a list of all enrollments for the passed course_id.
https://canvas.instructure.com/doc/api/enrollments.html#method.enrollments_api.index
"""
url = COURSES_API.format(course_id) + "/enrollments"
enrol... |
Return a list of all enrollments for the passed course sis id. | def get_enrollments_for_course_by_sis_id(self, sis_course_id, params={}):
"""
Return a list of all enrollments for the passed course sis id.
"""
return self.get_enrollments_for_course(
self._sis_id(sis_course_id, sis_field="course"), params) |
Return a list of all enrollments for the passed section_id. | def get_enrollments_for_section(self, section_id, params={}):
"""
Return a list of all enrollments for the passed section_id.
https://canvas.instructure.com/doc/api/enrollments.html#method.enrollments_api.index
"""
url = SECTIONS_API.format(section_id) + "/enrollments"
... |
Return a list of all enrollments for the passed section sis id. | def get_enrollments_for_section_by_sis_id(self, sis_section_id, params={}):
"""
Return a list of all enrollments for the passed section sis id.
"""
return self.get_enrollments_for_section(
self._sis_id(sis_section_id, sis_field="section"), params) |
Return a list of enrollments for the passed user regid. | def get_enrollments_for_regid(self, regid, params={},
include_courses=True):
"""
Return a list of enrollments for the passed user regid.
https://canvas.instructure.com/doc/api/enrollments.html#method.enrollments_api.index
"""
sis_user_id = self.... |
Enroll a user into a course. | def enroll_user(self, course_id, user_id, enrollment_type, params=None):
"""
Enroll a user into a course.
https://canvas.instructure.com/doc/api/enrollments.html#method.enrollments_api.create
"""
url = COURSES_API.format(course_id) + "/enrollments"
if not params:
... |
Calculates the foundation capacity according Vesics ( 1975 ) #Gunaratne Manjriker. 2006. Spread Footings: Analysis and Design. Ref: http:// geo. cv. nctu. edu. tw/ foundation/ download/ BearingCapacityOfFoundations. pdf | def capacity_vesics_1975(sl, fd, h_l=0, h_b=0, vertical_load=1, slope=0, base_tilt=0, verbose=0, gwl=1e6, **kwargs):
"""
Calculates the foundation capacity according Vesics(1975)
#Gunaratne, Manjriker. 2006. "Spread Footings: Analysis and Design."
Ref: http://geo.cv.nctu.edu.tw/foundation/download/
... |
Calculates the foundation capacity according Terzaghi ( 1943 ) Ref: http:// geo. cv. nctu. edu. tw/ foundation/ download/ BearingCapacityOfFoundations. pdf | def capacity_terzaghi_1943(sl, fd, round_footing=False, verbose=0, **kwargs):
"""
Calculates the foundation capacity according Terzaghi (1943)
Ref: http://geo.cv.nctu.edu.tw/foundation/
download/BearingCapacityOfFoundations.pdf
:param sl: Soil object
:param fd: Foundation object
:param roun... |
Calculates the foundation capacity according Hansen ( 1970 ) Ref: http:// bestengineeringprojects. com/ civil - projects/ hansens - bearing - capacity - theory/ | def capacity_hansen_1970(sl, fd, h_l=0, h_b=0, vertical_load=1, slope=0, base_tilt=0, verbose=0, **kwargs):
"""
Calculates the foundation capacity according Hansen (1970)
Ref: http://bestengineeringprojects.com/civil-projects/
hansens-bearing-capacity-theory/
:param sl: Soil object
:param fd: F... |
Calculates the foundation capacity according Meyerhoff ( 1963 ) http:// www. engs - comp. com/ meyerhof/ index. shtml | def capacity_meyerhof_1963(sl, fd, gwl=1e6, h_l=0, h_b=0, vertical_load=1, verbose=0, **kwargs):
"""
Calculates the foundation capacity according Meyerhoff (1963)
http://www.engs-comp.com/meyerhof/index.shtml
:param sl: Soil object
:param fd: Foundation object
:param h_l: Horizontal load parall... |
calculates the capacity according to Appendix B verification method 4 of the NZ building code | def capacity_nzs_vm4_2011(sl, fd, h_l=0, h_b=0, vertical_load=1, slope=0, verbose=0, **kwargs):
"""
calculates the capacity according to
Appendix B verification method 4 of the NZ building code
:param sl: Soil object
:param fd: Foundation object
:param h_l: Horizontal load parallel to length
... |
calculates the capacity according to THe Engineering of Foundations textbook by Salgado | def capacity_salgado_2008(sl, fd, h_l=0, h_b=0, vertical_load=1, verbose=0, **kwargs):
"""
calculates the capacity according to
THe Engineering of Foundations textbook by Salgado
ISBN: 0072500581
:param sl: Soil object
:param fd: Foundation object
:param h_l: Horizontal load parallel to ... |
Determine the size of a footing given an aspect ratio and a load: param sl: Soil object: param vertical_load: The applied load to the foundation: param fos: The target factor of safety: param length_to_width: The desired length to width ratio of the foundation: param verbose: verbosity: return: a Foundation object | def size_footing_for_capacity(sl, vertical_load, fos=1.0, length_to_width=1.0, verbose=0, **kwargs):
"""
Determine the size of a footing given an aspect ratio and a load
:param sl: Soil object
:param vertical_load: The applied load to the foundation
:param fos: The target factor of safety
:param... |
Calculates the bearing capacity of a foundation on soil using the specified method.: param sl: Soil Object: param fd: Foundation Object: param method: Method: param kwargs:: return: | def capacity_method_selector(sl, fd, method, **kwargs):
"""
Calculates the bearing capacity of a foundation on soil using the specified method.
:param sl: Soil Object
:param fd: Foundation Object
:param method: Method
:param kwargs:
:return:
"""
if method == 'vesics':
capaci... |
Calculates the two - layered foundation capacity according Meyerhof and Hanna ( 1978 ) | def deprecated_capacity_meyerhof_and_hanna_1978(sl_0, sl_1, h0, fd, verbose=0):
"""
Calculates the two-layered foundation capacity according Meyerhof and Hanna (1978)
:param sl_0: Top Soil object
:param sl_1: Base Soil object
:param h0: Height of top soil layer
:param fd: Foundation object
... |
Calculates the two - layered foundation capacity according Meyerhof and Hanna ( 1978 ) | def capacity_meyerhof_and_hanna_1978(sl_0, sl_1, h0, fd, gwl=1e6, verbose=0):
"""
Calculates the two-layered foundation capacity according Meyerhof and Hanna (1978)
:param sl_0: Top Soil object
:param sl_1: Base Soil object
:param h0: Height of top soil layer
:param fd: Foundation object
:p... |
Calculates the two - layered foundation capacity according Meyerhof and Hanna ( 1978 ) | def capacity_sp_meyerhof_and_hanna_1978(sp, fd, verbose=0):
"""
Calculates the two-layered foundation capacity according Meyerhof and Hanna (1978)
:param sp: Soil profile object
:param fd: Foundation object
:param wtl: water table level
:param verbose: verbosity
:return: ultimate bearing st... |
List the roles for an account for the passed Canvas account ID. | def get_roles_in_account(self, account_id, params={}):
"""
List the roles for an account, for the passed Canvas account ID.
https://canvas.instructure.com/doc/api/roles.html#method.role_overrides.api_index
"""
url = ACCOUNTS_API.format(account_id) + "/roles"
roles = []
... |
List the roles for an account for the passed account SIS ID. | def get_roles_by_account_sis_id(self, account_sis_id, params={}):
"""
List the roles for an account, for the passed account SIS ID.
"""
return self.get_roles_in_account(self._sis_id(account_sis_id,
sis_field="account"),
... |
List all course roles available to an account for the passed Canvas account ID including course roles inherited from parent accounts. | def get_effective_course_roles_in_account(self, account_id):
"""
List all course roles available to an account, for the passed Canvas
account ID, including course roles inherited from parent accounts.
"""
course_roles = []
params = {"show_inherited": "1"}
for role... |
Get information about a single role for the passed Canvas account ID. | def get_role(self, account_id, role_id):
"""
Get information about a single role, for the passed Canvas account ID.
https://canvas.instructure.com/doc/api/roles.html#method.role_overrides.show
"""
url = ACCOUNTS_API.format(account_id) + "/roles/{}".format(role_id)
return... |
Get information about a single role for the passed account SIS ID. | def get_role_by_account_sis_id(self, account_sis_id, role_id):
"""
Get information about a single role, for the passed account SIS ID.
"""
return self.get_role(self._sis_id(account_sis_id, sis_field="account"),
role_id) |
Return course resource for given canvas course id. | def get_course(self, course_id, params={}):
"""
Return course resource for given canvas course id.
https://canvas.instructure.com/doc/api/courses.html#method.courses.show
"""
include = params.get("include", [])
if "term" not in include:
include.append("term")... |
Return course resource for given sis id. | def get_course_by_sis_id(self, sis_course_id, params={}):
"""
Return course resource for given sis id.
"""
return self.get_course(self._sis_id(sis_course_id, sis_field="course"),
params) |
Returns a list of courses for the passed account ID. | def get_courses_in_account(self, account_id, params={}):
"""
Returns a list of courses for the passed account ID.
https://canvas.instructure.com/doc/api/accounts.html#method.accounts.courses_api
"""
if "published" in params:
params["published"] = "true" if params["pu... |
Return a list of courses for the passed account SIS ID. | def get_courses_in_account_by_sis_id(self, sis_account_id, params={}):
"""
Return a list of courses for the passed account SIS ID.
"""
return self.get_courses_in_account(
self._sis_id(sis_account_id, sis_field="account"), params) |
Return a list of published courses for the passed account ID. | def get_published_courses_in_account(self, account_id, params={}):
"""
Return a list of published courses for the passed account ID.
"""
params["published"] = True
return self.get_courses_in_account(account_id, params) |
Return a list of published courses for the passed account SIS ID. | def get_published_courses_in_account_by_sis_id(self, sis_account_id,
params={}):
"""
Return a list of published courses for the passed account SIS ID.
"""
return self.get_published_courses_in_account(
self._sis_id(sis_accoun... |
Return a list of courses for the passed regid. | def get_courses_for_regid(self, regid, params={}):
"""
Return a list of courses for the passed regid.
https://canvas.instructure.com/doc/api/courses.html#method.courses.index
"""
self._as_user = regid
data = self._get_resource("/api/v1/courses", params=params)
se... |
Create a canvas course with the given subaccount id and course name. | def create_course(self, account_id, course_name):
"""
Create a canvas course with the given subaccount id and course name.
https://canvas.instructure.com/doc/api/courses.html#method.courses.create
"""
url = ACCOUNTS_API.format(account_id) + "/courses"
body = {"course": {... |
Updates the SIS ID for the course identified by the passed course ID. | def update_sis_id(self, course_id, sis_course_id):
"""
Updates the SIS ID for the course identified by the passed course ID.
https://canvas.instructure.com/doc/api/courses.html#method.courses.update
"""
url = COURSES_API.format(course_id)
body = {"course": {"sis_course_i... |
Returns participation data for the given account_id and term_id. | def get_activity_by_account(self, account_id, term_id):
"""
Returns participation data for the given account_id and term_id.
https://canvas.instructure.com/doc/api/analytics.html#method.analytics_api.department_participation
"""
url = ("/api/v1/accounts/sis_account_id:%s/analyti... |
Returns grade data for the given account_id and term_id. | def get_grades_by_account(self, account_id, term_id):
"""
Returns grade data for the given account_id and term_id.
https://canvas.instructure.com/doc/api/analytics.html#method.analytics_api.department_grades
"""
url = ("/api/v1/accounts/sis_account_id:%s/analytics/"
... |
Returns statistics for the given account_id and term_id. | def get_statistics_by_account(self, account_id, term_id):
"""
Returns statistics for the given account_id and term_id.
https://canvas.instructure.com/doc/api/analytics.html#method.analytics_api.department_statistics
"""
url = ("/api/v1/accounts/sis_account_id:%s/analytics/"
... |
Returns participation data for the given sis_course_id. | def get_activity_by_sis_course_id(self, sis_course_id):
"""
Returns participation data for the given sis_course_id.
https://canvas.instructure.com/doc/api/analytics.html#method.analytics_api.course_participation
"""
url = "/api/v1/courses/%s/analytics/activity.json" % (
... |
Returns assignment data for the given course_id. | def get_assignments_by_sis_course_id(self, sis_course_id):
"""
Returns assignment data for the given course_id.
https://canvas.instructure.com/doc/api/analytics.html#method.analytics_api.course_assignments
"""
url = "/api/v1/courses/%s/analytics/assignments.json" % (
... |
Returns per - student data for the given course_id. | def get_student_summaries_by_sis_course_id(self, sis_course_id):
"""
Returns per-student data for the given course_id.
https://canvas.instructure.com/doc/api/analytics.html#method.analytics_api.course_student_summaries
"""
url = "/api/v1/courses/%s/analytics/student_summaries.js... |
Returns student activity data for the given user_id and course_id. | def get_student_activity_for_sis_course_id_and_sis_user_id(
self, sis_user_id, sis_course_id):
"""
Returns student activity data for the given user_id and course_id.
https://canvas.instructure.com/doc/api/analytics.html#method.analytics_api.student_in_course_participation
""... |
Returns student assignment data for the given user_id and course_id. | def get_student_assignments_for_sis_course_id_and_sis_user_id(
self, sis_user_id, sis_course_id):
"""
Returns student assignment data for the given user_id and course_id.
https://canvas.instructure.com/doc/api/analytics.html#method.analytics_api.student_in_course_assignments
... |
Returns student assignment data for the given user_id and course_id. | def get_student_assignments_for_sis_course_id_and_canvas_user_id(
self, sis_course_id, user_id):
"""
Returns student assignment data for the given user_id and course_id.
https://canvas.instructure.com/doc/api/analytics.html#method.analytics_api.student_in_course_assignments
... |
Returns student messaging data for the given user_id and course_id. | def get_student_messaging_for_sis_course_id_and_sis_user_id(
self, sis_user_id, sis_course_id):
"""
Returns student messaging data for the given user_id and course_id.
https://canvas.instructure.com/doc/api/analytics.html#method.analytics_api.student_in_course_messaging
"""
... |
https:// canvas. instructure. com/ doc/ api/ submissions. html#method. submissions_api. index | def get_submissions_by_course_and_assignment(
self, course_id, assignment_id, params={}):
"""
https://canvas.instructure.com/doc/api/submissions.html#method.submissions_api.index
"""
url = COURSES_API.format(course_id)
url += "/assignments/{}/submissions".format(assig... |
List submissions for multiple assignments by course/ section sis id and optionally student | def get_submissions_multiple_assignments_by_sis_id(
self, is_section, sis_id, students=None, assignments=None,
**params):
"""
List submissions for multiple assignments by course/section sis id and
optionally student
https://canvas.instructure.com/doc/api/submissi... |
List submissions for multiple assignments by course/ section id and optionally student | def get_submissions_multiple_assignments(
self, is_section, course_id, students=None, assignments=None,
**params):
"""
List submissions for multiple assignments by course/section id and
optionally student
https://canvas.instructure.com/doc/api/submissions.html#me... |
Rotation stiffness of foundation.: param fd: Foundation object: param sl: Soil Object.: param axis: The axis which it should be computed around: return: | def rotational_stiffness(sl, fd, axis="length", a0=0.0, **kwargs):
"""
Rotation stiffness of foundation.
:param fd: Foundation object
:param sl: Soil Object.
:param axis: The axis which it should be computed around
:return:
"""
if not kwargs.get("disable_requires", False):
gf.mod... |
Return external tools for the passed canvas account id. | def get_external_tools_in_account(self, account_id, params={}):
"""
Return external tools for the passed canvas account id.
https://canvas.instructure.com/doc/api/external_tools.html#method.external_tools.index
"""
url = ACCOUNTS_API.format(account_id) + "/external_tools"
... |
Return external tools for the passed canvas course id. | def get_external_tools_in_course(self, course_id, params={}):
"""
Return external tools for the passed canvas course id.
https://canvas.instructure.com/doc/api/external_tools.html#method.external_tools.index
"""
url = COURSES_API.format(course_id) + "/external_tools"
ex... |
Create an external tool using the passed json_data. | def _create_external_tool(self, context, context_id, json_data):
"""
Create an external tool using the passed json_data.
context is either COURSES_API or ACCOUNTS_API.
context_id is the Canvas course_id or account_id, depending on context.
https://canvas.instructure.com/doc/api... |
Update the external tool identified by external_tool_id with the passed json data. | def _update_external_tool(self, context, context_id, external_tool_id,
json_data):
"""
Update the external tool identified by external_tool_id with the passed
json data.
context is either COURSES_API or ACCOUNTS_API.
context_id is the course_id or a... |
Delete the external tool identified by external_tool_id. | def _delete_external_tool(self, context, context_id, external_tool_id):
"""
Delete the external tool identified by external_tool_id.
context is either COURSES_API or ACCOUNTS_API.
context_id is the course_id or account_id, depending on context
https://canvas.instructure.com/doc... |
Get a sessionless launch url for an external tool. | def _get_sessionless_launch_url(self, context, context_id, tool_id):
"""
Get a sessionless launch url for an external tool.
https://canvas.instructure.com/doc/api/external_tools.html#method.external_tools.generate_sessionless_launch
"""
url = context.format(context_id) + "/exter... |
Get a sessionless launch url for an external tool. | def get_sessionless_launch_url_from_account_sis_id(
self, tool_id, account_sis_id):
"""
Get a sessionless launch url for an external tool.
https://canvas.instructure.com/doc/api/external_tools.html#method.external_tools.generate_sessionless_launch
"""
return self.get... |
Get a sessionless launch url for an external tool. | def get_sessionless_launch_url_from_course_sis_id(
self, tool_id, course_sis_id):
"""
Get a sessionless launch url for an external tool.
https://canvas.instructure.com/doc/api/external_tools.html#method.external_tools.generate_sessionless_launch
"""
return self.get_s... |
Can define a Foundation Object from dimensions.: param length: Foundation length: param width: Foundation width: param depth: Foundation depth: param height: Foundation height: return: A Foundation object | def create_foundation(length, width, depth=0.0, height=0.0):
"""
Can define a Foundation Object from dimensions.
:param length: Foundation length
:param width: Foundation width
:param depth: Foundation depth
:param height: Foundation height
:return: A Foundation object
"""
a_foundati... |
Can define a Soil object.: param phi: Internal friction angle: param cohesion: Cohesion of soil: param unit_dry_weight: The dry unit weight of the soil.: param pw: specific weight of water: return: A Soil object. | def create_soil(phi=0.0, cohesion=0.0, unit_dry_weight=0.0, pw=9800):
"""
Can define a Soil object.
:param phi: Internal friction angle
:param cohesion: Cohesion of soil
:param unit_dry_weight: The dry unit weight of the soil.
:param pw: specific weight of water
:return: A Soil object.
"... |
Check if a parameter is available on an object | def check_required(obj, required_parameters):
"""
Check if a parameter is available on an object
:param obj: Object
:param required_parameters: list of parameters
:return:
"""
for parameter in required_parameters:
if not hasattr(obj, parameter) or getattr(obj, parameter) is None:
... |
Returns user profile data. | def get_user(self, user_id):
"""
Returns user profile data.
https://canvas.instructure.com/doc/api/users.html#method.profile.settings
"""
url = USERS_API.format(user_id) + "/profile"
return CanvasUser(data=self._get_resource(url)) |
Returns a list of users for the given course id. | def get_users_for_course(self, course_id, params={}):
"""
Returns a list of users for the given course id.
"""
url = COURSES_API.format(course_id) + "/users"
data = self._get_paged_resource(url, params=params)
users = []
for datum in data:
users.append... |
Returns a list of users for the given sis course id. | def get_users_for_sis_course_id(self, sis_course_id, params={}):
"""
Returns a list of users for the given sis course id.
"""
return self.get_users_for_course(
self._sis_id(sis_course_id, sis_field="course"), params) |
Create and return a new user and pseudonym for an account. | def create_user(self, user, account_id=None):
"""
Create and return a new user and pseudonym for an account.
https://canvas.instructure.com/doc/api/users.html#method.users.create
"""
if account_id is None:
account_id = self._canvas_account_id
if account_i... |
Return a user s logins for the given user_id. | def get_user_logins(self, user_id, params={}):
"""
Return a user's logins for the given user_id.
https://canvas.instructure.com/doc/api/logins.html#method.pseudonyms.index
"""
url = USERS_API.format(user_id) + "/logins"
data = self._get_paged_resource(url, params=params... |
Update an existing login for a user in the given account. | def update_user_login(self, login, account_id=None):
"""
Update an existing login for a user in the given account.
https://canvas.instructure.com/doc/api/logins.html#method.pseudonyms.update
"""
if account_id is None:
account_id = self._canvas_account_id
... |
return url path to next page of paginated data | def _next_page(self, response):
"""
return url path to next page of paginated data
"""
for link in response.getheader("link", "").split(","):
try:
(url, rel) = link.split(";")
if "next" in rel:
return url.lstrip("<").rstrip(... |
Canvas GET method on a full url. Return representation of the requested resource chasing pagination links to coalesce resources if indicated. | def _get_resource_url(self, url, auto_page, data_key):
"""
Canvas GET method on a full url. Return representation of the
requested resource, chasing pagination links to coalesce resources
if indicated.
"""
headers = {'Accept': 'application/json',
'Conne... |
Canvas GET method. Return representation of the requested paged resource either the requested page or chase pagination links to coalesce resources. | def _get_paged_resource(self, url, params=None, data_key=None):
"""
Canvas GET method. Return representation of the requested paged
resource, either the requested page, or chase pagination links to
coalesce resources.
"""
if not params:
params = {}
se... |
Canvas GET method. Return representation of the requested resource. | def _get_resource(self, url, params=None, data_key=None):
"""
Canvas GET method. Return representation of the requested resource.
"""
if not params:
params = {}
self._set_as_user(params)
full_url = url + self._params(params)
return self._get_resourc... |
Canvas PUT method. | def _put_resource(self, url, body):
"""
Canvas PUT method.
"""
params = {}
self._set_as_user(params)
headers = {'Content-Type': 'application/json',
'Accept': 'application/json',
'Connection': 'keep-alive'}
url = url + self._pa... |
Canvas POST method. | def _post_resource(self, url, body):
"""
Canvas POST method.
"""
params = {}
self._set_as_user(params)
headers = {'Content-Type': 'application/json',
'Accept': 'application/json',
'Connection': 'keep-alive'}
url = url + self._... |
Canvas DELETE method. | def _delete_resource(self, url):
"""
Canvas DELETE method.
"""
params = {}
self._set_as_user(params)
headers = {'Accept': 'application/json',
'Connection': 'keep-alive'}
url = url + self._params(params)
response = DAO.deleteURL(url, head... |
Return a list of the admins in the account. | def get_admins(self, account_id, params={}):
"""
Return a list of the admins in the account.
https://canvas.instructure.com/doc/api/admins.html#method.admins.index
"""
url = ADMINS_API.format(account_id)
admins = []
for data in self._get_paged_resource(url, para... |
Flag an existing user as an admin within the account. | def create_admin(self, account_id, user_id, role):
"""
Flag an existing user as an admin within the account.
https://canvas.instructure.com/doc/api/admins.html#method.admins.create
"""
url = ADMINS_API.format(account_id)
body = {"user_id": unquote(str(user_id)),
... |
Flag an existing user as an admin within the account sis id. | def create_admin_by_sis_id(self, sis_account_id, user_id, role):
"""
Flag an existing user as an admin within the account sis id.
"""
return self.create_admin(self._sis_id(sis_account_id), user_id, role) |
Remove an account admin role from a user. | def delete_admin(self, account_id, user_id, role):
"""
Remove an account admin role from a user.
https://canvas.instructure.com/doc/api/admins.html#method.admins.destroy
"""
url = ADMINS_API.format(account_id) + "/{}?role={}".format(
user_id, quote(role))
re... |
Remove an account admin role from a user for the account sis id. | def delete_admin_by_sis_id(self, sis_account_id, user_id, role):
"""
Remove an account admin role from a user for the account sis id.
"""
return self.delete_admin(self._sis_id(sis_account_id), user_id, role) |
List the grading standards available to a course https:// canvas. instructure. com/ doc/ api/ grading_standards. html#method. grading_standards_api. context_index | def get_grading_standards_for_course(self, course_id):
"""
List the grading standards available to a course
https://canvas.instructure.com/doc/api/grading_standards.html#method.grading_standards_api.context_index
"""
url = COURSES_API.format(course_id) + "/grading_standards"
... |
Create a new grading standard for the passed course. | def create_grading_standard_for_course(self, course_id, name,
grading_scheme, creator):
"""
Create a new grading standard for the passed course.
https://canvas.instructure.com/doc/api/grading_standards.html#method.grading_standards_api.create
"... |
Return section resource for given canvas section id. | def get_section(self, section_id, params={}):
"""
Return section resource for given canvas section id.
https://canvas.instructure.com/doc/api/sections.html#method.sections.show
"""
url = SECTIONS_API.format(section_id)
return CanvasSection(data=self._get_resource(url, pa... |
Return section resource for given sis id. | def get_section_by_sis_id(self, sis_section_id, params={}):
"""
Return section resource for given sis id.
"""
return self.get_section(
self._sis_id(sis_section_id, sis_field="section"), params) |
Return list of sections for the passed course ID. | def get_sections_in_course(self, course_id, params={}):
"""
Return list of sections for the passed course ID.
https://canvas.instructure.com/doc/api/sections.html#method.sections.index
"""
url = COURSES_API.format(course_id) + "/sections"
sections = []
for data ... |
Return list of sections for the passed course SIS ID. | def get_sections_in_course_by_sis_id(self, sis_course_id, params={}):
"""
Return list of sections for the passed course SIS ID.
"""
return self.get_sections_in_course(
self._sis_id(sis_course_id, sis_field="course"), params) |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.