[docs]class DisplayTaskAlias(_BaseEvergreenObject):
- """Representation of a DisplayTask in an alias."""
+ """Representation of a DisplayTask in an alias."""
name = evg_attrib("Name")
execution_tasks = evg_attrib("ExecutionTasks")
def __init__(self, json: Dict[str, Any], api: "EvergreenApi") -> None:
- """
+ """
Create an instance of a display task alias.
:param json: json representing a display task alias.
@@ -68,13 +70,13 @@ Source code for evergreen.alias
[docs]class VariantAlias(_BaseEvergreenObject):
- """Representation of an alias for a particular build variant."""
+ """Representation of an alias for a particular build variant."""
variant = evg_attrib("Variant")
tasks = evg_attrib("Tasks")
def __init__(self, json: Dict[str, Any], api: "EvergreenApi") -> None:
- """
+ """
Create an instance of a variant alias.
:param json: json representing variant alias.
@@ -84,7 +86,7 @@ Source code for evergreen.alias
@property
def display_tasks(self) -> List[DisplayTaskAlias]:
- """Get a list of display tasks for the alias."""
+ """Get a list of display tasks for the alias."""
if not self.json["DisplayTasks"]:
return []
return [DisplayTaskAlias(dt, self._api) for dt in self.json["DisplayTasks"]]
@@ -106,19 +108,19 @@ Source code for evergreen.alias
Quick search
-
+
diff --git a/_modules/evergreen/api.html b/_modules/evergreen/api.html
index beea807e..c553e31b 100644
--- a/_modules/evergreen/api.html
+++ b/_modules/evergreen/api.html
@@ -1,17 +1,19 @@
-
+
- evergreen.api — evergreen.py 3.6.19 documentation
-
-
-
+ evergreen.api — evergreen.py 3.6.20 documentation
+
+
+
+
+
@@ -114,7 +116,7 @@ Source code for evergreen.api
[docs]class EvergreenApi(object):
- """Base methods for building API objects."""
+ """Base methods for building API objects."""
def __init__(
self,
@@ -125,7 +127,7 @@ Source code for evergreen.api
log_on_error: bool = False,
use_default_logger_factory: bool = True,
) -> None:
- """
+ """
Create a _BaseEvergreenApi object.
:param api_server: URI of Evergreen API server.
@@ -146,7 +148,7 @@ Source code for evergreen.api
[docs] @contextmanager
def with_session(self) -> Generator["EvergreenApi", None, None]:
- """Yield an instance of the API client with a shared session."""
+ """Yield an instance of the API client with a shared session."""
session = self._create_session()
evg_api = EvergreenApi(
self._api_server, self._auth, self._timeout, session, self._log_on_error
@@ -155,7 +157,7 @@ Source code for evergreen.api
@property
def session(self) -> requests.Session:
- """
+ """
Get the shared session if it exists, else create a new session.
:return: Session to query the API with.
@@ -166,7 +168,7 @@ Source code for evergreen.api
return self._create_session()
def _create_session(self) -> requests.Session:
- """Create a new session to query the API with."""
+ """Create a new session to query the API with."""
session = requests.Session()
adapter = requests.adapters.HTTPAdapter()
session.mount(f"{urlparse(self._api_server).scheme}://", adapter)
@@ -176,7 +178,7 @@ Source code for evergreen.api
return session
def _create_url(self, endpoint: str) -> str:
- """
+ """
Format a call to a v2 REST API endpoint.
:param endpoint: endpoint to call.
@@ -185,7 +187,7 @@ Source code for evergreen.api
return f"{self._api_server}/rest/v2{endpoint}"
def _create_plugin_url(self, endpoint: str) -> str:
- """
+ """
Format the a call to a plugin endpoint.
:param endpoint: endpoint to call.
@@ -195,7 +197,7 @@ Source code for evergreen.api
@staticmethod
def _log_api_call_time(response: requests.Response, start_time: float) -> None:
- """
+ """
Log how long the api call took.
:param response: Response from API.
@@ -208,9 +210,13 @@ Source code for evergreen.api
LOGGER.debug("Request completed.", url=response.request.url, duration=duration)
def _call_api(
- self, url: str, params: Dict = None, method: str = "GET", data: Optional[str] = None
+ self,
+ url: str,
+ params: Optional[Dict] = None,
+ method: str = "GET",
+ data: Optional[str] = None,
) -> requests.Response:
- """
+ """
Make a call to the evergreen api.
:param url: Url of call to make.
@@ -253,7 +259,7 @@ Source code for evergreen.api
chunk_size: Optional[int] = None,
is_binary: bool = False,
) -> Iterable:
- """
+ """
Make a streaming call based on if artifact is binary or nonbinary.
:param url: url to call
@@ -275,7 +281,7 @@ Source code for evergreen.api
yield line
def _raise_for_status(self, response: requests.Response) -> None:
- """
+ """
Raise an exception with the evergreen message if it exists.
:param response: response from evergreen api.
@@ -299,9 +305,9 @@ Source code for evergreen.api
response.raise_for_status()
def _paginate(
- self, url: str, params: Dict = None
+ self, url: str, params: Optional[Dict] = None
) -> Union[List[Dict[str, Any]], Dict[str, Any]]:
- """
+ """
Paginate until all results are returned and return a list of all JSON results.
:param url: url to make request to.
@@ -319,8 +325,8 @@ Source code for evergreen.api
return json_data
- def _lazy_paginate(self, url: str, params: Dict = None) -> Iterable:
- """
+ def _lazy_paginate(self, url: str, params: Optional[Dict] = None) -> Iterable:
+ """
Lazy paginate, the results are returned lazily.
:param url: URL to query.
@@ -345,8 +351,8 @@ Source code for evergreen.api
next_url = response.links["next"]["url"]
- def _lazy_paginate_by_date(self, url: str, params: Dict = None) -> Iterable:
- """
+ def _lazy_paginate_by_date(self, url: str, params: Optional[Dict] = None) -> Iterable:
+ """
Paginate based on date, the results are returned lazily.
:param url: URL to query.
@@ -367,7 +373,7 @@ Source code for evergreen.api
params["start_at"] = evergreen_input_to_output(data[-1]["create_time"])
[docs] def all_distros(self) -> List[Distro]:
- """
+ """
Get all distros in evergreen.
:return: List of all distros in evergreen.
@@ -377,7 +383,7 @@ Source code for evergreen.api
return [Distro(distro, self) for distro in distro_list] # type: ignore[arg-type]
[docs] def all_hosts(self, status: Optional[str] = None) -> List[Host]:
- """
+ """
Get all hosts in evergreen.
:param status: Only return hosts with specified status.
@@ -392,7 +398,7 @@ Source code for evergreen.api
return [Host(host, self) for host in host_list] # type: ignore[arg-type]
[docs] def host_by_id(self, host_id: str) -> Host:
- """
+ """
Get evergreen host by id.
:param host_id: host ids, 'i-000cba730e92eb85b'
@@ -404,7 +410,7 @@ Source code for evergreen.api
[docs] def configure_task(
self, task_id: str, activated: Optional[bool] = None, priority: Optional[int] = None
) -> None:
- """
+ """
Update a task.
:param task_id: Id of the task to update
@@ -420,7 +426,7 @@ Source code for evergreen.api
self._call_api(url, data=json.dumps(data), method="PATCH")
[docs] def restart_task(self, task_id: str) -> None:
- """
+ """
Restart a task.
:param task_id: Id of the task to restart
@@ -429,7 +435,7 @@ Source code for evergreen.api
self._call_api(url, method="POST")
[docs] def abort_task(self, task_id: str) -> None:
- """
+ """
Abort a task.
:param task_id: Id of the task to abort
@@ -438,7 +444,7 @@ Source code for evergreen.api
self._call_api(url, method="POST")
[docs] def all_projects(self, project_filter_fn: Optional[Callable] = None) -> List[Project]:
- """
+ """
Get all projects in evergreen.
:param project_filter_fn: function to filter projects, should accept a project_id argument.
@@ -452,7 +458,7 @@ Source code for evergreen.api
return projects
[docs] def project_by_id(self, project_id: str) -> Project:
- """
+ """
Get a project by project_id.
:param project_id: Id of project to query.
@@ -464,7 +470,7 @@ Source code for evergreen.api
[docs] def recent_versions_by_project(
self, project_id: str, params: Optional[Dict] = None
) -> RecentVersions:
- """
+ """
Get recent versions created in specified project.
:param project_id: Id of project to query.
@@ -478,7 +484,7 @@ Source code for evergreen.api
[docs] def send_slack_message(
self, target: str, msg: str, attachments: Optional[List[SlackAttachment]] = None
) -> None:
- """
+ """
Send a Slack message to a user or channel in Slack.
:param target: The slack name of the user or channel to send the message to.
@@ -507,7 +513,7 @@ Source code for evergreen.api
is_plain_text: Optional[bool] = None,
headers: Optional[Dict[str, List[str]]] = None,
) -> None:
- """
+ """
Send an email to a user.
:param recipients: Who to send the email to.
@@ -538,7 +544,7 @@ Source code for evergreen.api
[docs] def alias_for_version(
self, version_id: str, alias: str, include_deps: bool = False
) -> List[VariantAlias]:
- """
+ """
Get the tasks and variants that an alias would select for an evergreen version.
:param version_id: Evergreen version to query against.
@@ -563,7 +569,7 @@ Source code for evergreen.api
revision_start: Optional[int] = None,
revision_end: Optional[int] = None,
) -> Iterator[Version]:
- """
+ """
Get the versions created in the specified project.
:param project_id: Id of project to query.
@@ -595,7 +601,7 @@ Source code for evergreen.api
requester: Requester = Requester.GITTER_REQUEST,
time_attr: str = "create_time",
) -> Iterable[Version]:
- """
+ """
Get an iterator over the patches for the given time window.
:param project_id: Id of project to query.
@@ -609,8 +615,8 @@ Source code for evergreen.api
self.versions_by_project(project_id, requester), before, after, time_attr
)
-[docs] def patches_by_project(self, project_id: str, params: Dict = None) -> Iterable[Patch]:
- """
+[docs] def patches_by_project(self, project_id: str, params: Optional[Dict] = None) -> Iterable[Patch]:
+ """
Get a list of patches for the specified project.
:param project_id: Id of project to query.
@@ -624,7 +630,7 @@ Source code for evergreen.api
[docs] def update_patch_status(
self, patch_id: str, activated: Optional[bool] = None, priority: Optional[int] = None
) -> None:
- """
+ """
Update a patch and set its status.
:param patch_id: Id of the patch to update
@@ -645,7 +651,7 @@ Source code for evergreen.api
variants: List[Dict[str, Union[str, List[str]]]],
description: Optional[str] = None,
) -> None:
- """
+ """
Update a patch.
:param patch_id: Id of the patch to update
@@ -668,10 +674,10 @@ Source code for evergreen.api
project_id: str,
before: datetime,
after: datetime,
- params: Dict = None,
+ params: Optional[Dict] = None,
time_attr: str = "create_time",
) -> Iterable[Patch]:
- """
+ """
Get an iterator over the patches for the given time window.
:param project_id: Id of project to query.
@@ -688,7 +694,7 @@ Source code for evergreen.api
[docs] def patches_by_user(
self, user_id: str, start_at: Optional[datetime] = None, limit: Optional[int] = None
) -> Iterable[Patch]:
- """
+ """
Get an iterable of recent patches by the given user.
:param user_id: Id of user to query.
@@ -704,7 +710,7 @@ Source code for evergreen.api
return (Patch(patch, self) for patch in self._lazy_paginate(url, params))
[docs] def commit_queue_for_project(self, project_id: str) -> CommitQueue:
- """
+ """
Get the current commit queue for the specified project.
:param project_id: Id of project to query.
@@ -727,7 +733,7 @@ Source code for evergreen.api
group_by: Optional[str] = None,
sort: Optional[str] = None,
) -> List[TestStats]:
- """
+ """
Get a patch by patch id.
:param project_id: Id of patch to query for.
@@ -768,7 +774,7 @@ Source code for evergreen.api
return [TestStats(test_stat, self) for test_stat in test_stats_list] # type: ignore[arg-type]
[docs] def tasks_by_project(self, project_id: str, statuses: Optional[List[str]] = None) -> List[Task]:
- """
+ """
Get all the tasks for a project.
:param project_id: The project's id.
@@ -782,7 +788,7 @@ Source code for evergreen.api
[docs] def tasks_by_project_and_commit(
self, project_id: str, commit_hash: str, params: Optional[Dict] = None
) -> List[Task]:
- """
+ """
Get all the tasks for a revision in specified project.
:param project_id: Project id associated with the revision
@@ -801,7 +807,7 @@ Source code for evergreen.api
num_versions: Optional[int] = None,
start_at: Optional[int] = None,
) -> List[Task]:
- """
+ """
Get all the tasks for a project by task name.
:param project_id: Id of project to query.
@@ -835,7 +841,7 @@ Source code for evergreen.api
group_by: Optional[str] = None,
sort: Optional[str] = None,
) -> List[TaskStats]:
- """
+ """
Get task stats by project id.
:param project_id: Id of patch to query for.
@@ -885,7 +891,7 @@ Source code for evergreen.api
group_by: Optional[str] = None,
sort: Optional[str] = None,
) -> List[TaskReliability]:
- """
+ """
Get task reliability scores.
:param project_id: Id of patch to query for.
@@ -927,7 +933,7 @@ Source code for evergreen.api
]
[docs] def build_by_id(self, build_id: str) -> Build:
- """
+ """
Get a build by id.
:param build_id: build id to query.
@@ -939,7 +945,7 @@ Source code for evergreen.api
[docs] def tasks_by_build(
self, build_id: str, fetch_all_executions: Optional[bool] = None
) -> List[Task]:
- """
+ """
Get all tasks for a given build.
:param build_id: build_id to query.
@@ -955,7 +961,7 @@ Source code for evergreen.api
return [Task(task, self) for task in task_list] # type: ignore[arg-type]
[docs] def version_by_id(self, version_id: str) -> Version:
- """
+ """
Get version by version id.
:param version_id: Id of version to query.
@@ -965,7 +971,7 @@ Source code for evergreen.api
return Version(self._paginate(url), self) # type: ignore[arg-type]
[docs] def builds_by_version(self, version_id: str, params: Optional[Dict] = None) -> List[Build]:
- """
+ """
Get all builds for a given Evergreen version_id.
:param version_id: Version Id to query for.
@@ -976,8 +982,8 @@ Source code for evergreen.api
build_list = self._paginate(url, params)
return [Build(build, self) for build in build_list] # type: ignore[arg-type]
-[docs] def patch_by_id(self, patch_id: str, params: Dict = None) -> Patch:
- """
+[docs] def patch_by_id(self, patch_id: str, params: Optional[Dict] = None) -> Patch:
+ """
Get a patch by patch id.
:param patch_id: Id of patch to query for.
@@ -988,7 +994,7 @@ Source code for evergreen.api
return Patch(self._call_api(url, params).json(), self) # type: ignore[arg-type]
[docs] def get_patch_diff(self, patch_id: str) -> str:
- """
+ """
Get the diff for a given patch.
:param patch_id: The id of the patch to request the diff for.
@@ -1000,7 +1006,7 @@ Source code for evergreen.api
def _execute_patch_file_command(
self, command: str, author: Optional[str] = None
) -> PatchCreationDetails:
- """
+ """
Execute a patch file command.
:param command: The command
@@ -1035,7 +1041,7 @@ Source code for evergreen.api
variant: str,
author: Optional[str] = None,
) -> PatchCreationDetails:
- """
+ """
Start a patch build based on a patch.
:param diff_file_path: The path to the diff.
@@ -1063,7 +1069,7 @@ Source code for evergreen.api
variant: str,
author: Optional[str] = None,
) -> PatchCreationDetails:
- """
+ """
Start a patch build based on a diff.
:param patch_id: The patch_id to base this build on.
@@ -1087,7 +1093,7 @@ Source code for evergreen.api
fetch_all_executions: Optional[bool] = None,
execution: Optional[int] = None,
) -> Task:
- """
+ """
Get a task by task_id.
:param task_id: Id of task to query for.
@@ -1106,7 +1112,7 @@ Source code for evergreen.api
[docs] def tests_by_task(
self, task_id: str, status: Optional[str] = None, execution: Optional[int] = None
) -> List[Tst]:
- """
+ """
Get all tests for a given task.
:param task_id: Id of task to query for.
@@ -1123,7 +1129,7 @@ Source code for evergreen.api
return [Tst(test, self) for test in self._paginate(url, params)] # type: ignore[arg-type]
[docs] def single_test_by_task_and_test_file(self, task_id: str, test_file: str) -> List[Tst]:
- """
+ """
Get a test for a given task.
:param task_id: Id of task to query for.
@@ -1135,7 +1141,7 @@ Source code for evergreen.api
return [Tst(test, self) for test in self._call_api(url, params=param).json()]
[docs] def num_of_tests_by_task(self, task_id: str) -> int:
- """
+ """
Get the number of tests that ran as part of the given task.
:param task_id: Id of task to query for.
@@ -1145,7 +1151,7 @@ Source code for evergreen.api
return int(self._call_api(url).text)
[docs] def manifest_for_task(self, task_id: str) -> Optional[Manifest]:
- """
+ """
Get the manifest for the given task.
:param task_id: Task Id fo query.
@@ -1168,7 +1174,7 @@ Source code for evergreen.api
execution: Optional[int] = None,
fetch_all_executions: Optional[bool] = None,
) -> List[TaskAnnotation]:
- """
+ """
Get the task annotations for the given task.
:param task_id: Id of task to query.
@@ -1194,7 +1200,7 @@ Source code for evergreen.api
[docs] def file_ticket_for_task(
self, task_id: str, execution: int, ticket_link: str, ticket_key: str
) -> None:
- """
+ """
Update an Evergreen task with information about a ticket created from it.
:param task_id: The id of the task to update.
@@ -1219,7 +1225,7 @@ Source code for evergreen.api
metadata: Optional[Dict[str, Any]] = None,
metadata_links: Optional[List[MetadataLinkRequest]] = None,
) -> None:
- """
+ """
Annotate the specified task.
:param task_id: ID of task to annotate.
@@ -1256,7 +1262,7 @@ Source code for evergreen.api
self._call_api(url, method="PUT", data=json.dumps(request))
[docs] def performance_results_by_task(self, task_id: str) -> PerformanceData:
- """
+ """
Get the 'perf.json' performance results for a given task_id.
:param task_id: Id of task to query for.
@@ -1268,7 +1274,7 @@ Source code for evergreen.api
[docs] def performance_results_by_task_name(
self, task_id: str, task_name: str
) -> List[PerformanceData]:
- """
+ """
Get the 'perf.json' performance results for a given task_id and task_name.
:param task_id: Id of task to query for.
@@ -1279,7 +1285,7 @@ Source code for evergreen.api
return [PerformanceData(result, self) for result in self._paginate(url)] # type: ignore[arg-type]
[docs] def json_by_task(self, task_id: str, json_key: str) -> Dict[str, Any]:
- """
+ """
Get the json reported for task {task_id} using the key {json_key}.
:param task_id: Id of task to query for.
@@ -1292,7 +1298,7 @@ Source code for evergreen.api
[docs] def json_history_for_task(
self, task_id: str, task_name: str, json_key: str
) -> List[Dict[str, Any]]:
- """
+ """
Get the history of json reported for task {task_id} using the key {json_key}.
:param task_id: Id of task to query for.
@@ -1304,7 +1310,7 @@ Source code for evergreen.api
return cast(List[Dict[str, Any]], self._paginate(url))
def _create_old_url(self, endpoint: str) -> str:
- """
+ """
Build a url for an pre-v2 endpoint.
:param endpoint: endpoint to build url for.
@@ -1313,7 +1319,7 @@ Source code for evergreen.api
return f"{self._api_server}/{endpoint}"
[docs] def manifest(self, project_id: str, revision: str) -> Manifest:
- """
+ """
Get the manifest for the given revision.
:param project_id: Project the revision belongs to.
@@ -1324,7 +1330,7 @@ Source code for evergreen.api
return Manifest(self._call_api(url).json(), self) # type: ignore[arg-type]
[docs] def retrieve_task_log(self, log_url: str, raw: bool = False) -> str:
- """
+ """
Get the request log file from a task.
:param log_url: URL of log to retrieve.
@@ -1337,7 +1343,7 @@ Source code for evergreen.api
return self._call_api(log_url, params=params).text
[docs] def stream_log(self, log_url: str) -> Iterable:
- """
+ """
Stream the given log url as a python generator.
:param log_url: URL of log file to stream.
@@ -1347,7 +1353,7 @@ Source code for evergreen.api
return self._stream_api(log_url, params)
[docs] def permissions_for_user(self, user_id: str) -> List[ResourceTypePermissions]:
- """
+ """
Get the permissions a user has on evergreen resources.
:param user_id: Id of the user whose permissions to get.
@@ -1364,7 +1370,7 @@ Source code for evergreen.api
resources: List[str],
permissions: Dict[str, int],
) -> None:
- """
+ """
Grant a user permissions to evergreen resources.
:param user_id: Id of the user to give permissions to.
@@ -1382,7 +1388,7 @@ Source code for evergreen.api
self._call_api(url, method="POST", data=json.dumps(payload))
[docs] def give_roles_to_user(self, user_id: str, roles: List[str], create_user: bool = False) -> None:
- """
+ """
Add the specified role to the specified user.
:param user_id: Id of the user to give the roles to.
@@ -1400,7 +1406,7 @@ Source code for evergreen.api
[docs] def delete_user_permissions(
self, user_id: str, resource_type: RemovablePermission, resource_id: Optional[str] = None
) -> None:
- """
+ """
Delete all permissions of a given type for a user.
:param user_id: Id of the user whose permissions to remove.
@@ -1415,7 +1421,7 @@ Source code for evergreen.api
self._call_api(url, method="DELETE", data=json.dumps(payload))
[docs] def get_users_for_role(self, role: str) -> UsersForRole:
- """
+ """
Get a list of users having an evergreen role.
:param role: Role to fetch users for.
@@ -1426,7 +1432,7 @@ Source code for evergreen.api
[docs] def all_user_permissions_for_resource(
self, resource_id: str, resource_type: PermissionableResourceType
) -> Dict[str, Dict[str, int]]:
- """
+ """
Get all users with their permissions to the resource.
The returned dict has the following structure -
@@ -1462,7 +1468,7 @@ Source code for evergreen.api
timeout: Optional[int] = DEFAULT_NETWORK_TIMEOUT_SEC,
log_on_error: bool = False,
) -> "EvergreenApi":
- """
+ """
Get an evergreen api instance based on config file settings.
:param auth: EvgAuth with authentication to use.
@@ -1511,7 +1517,7 @@ Source code for evergreen.api
[docs]class CachedEvergreenApi(EvergreenApi):
- """Access to the Evergreen API server that caches certain calls."""
+ """Access to the Evergreen API server that caches certain calls."""
def __init__(
self,
@@ -1520,14 +1526,14 @@ Source code for evergreen.api
timeout: Optional[int] = None,
log_on_error: bool = False,
) -> None:
- """Create an Evergreen Api object."""
+ """Create an Evergreen Api object."""
super(CachedEvergreenApi, self).__init__(
api_server, auth, timeout, log_on_error=log_on_error
)
[docs] @lru_cache(maxsize=CACHE_SIZE)
def build_by_id(self, build_id: str) -> Build: # type: ignore[override]
- """
+ """
Get a build by id.
:param build_id: build id to query.
@@ -1537,7 +1543,7 @@ Source code for evergreen.api
[docs] @lru_cache(maxsize=CACHE_SIZE)
def version_by_id(self, version_id: str) -> Version: # type: ignore[override]
- """
+ """
Get version by version id.
:param version_id: Id of version to query.
@@ -1546,7 +1552,7 @@ Source code for evergreen.api
return super(CachedEvergreenApi, self).version_by_id(version_id)
[docs] def clear_caches(self) -> None:
- """Clear the cache."""
+ """Clear the cache."""
cached_functions = [
self.build_by_id,
self.version_by_id,
@@ -1556,7 +1562,7 @@ Source code for evergreen.api
[docs]class RetryingEvergreenApi(EvergreenApi):
- """An Evergreen Api that retries failed calls."""
+ """An Evergreen Api that retries failed calls."""
def __init__(
self,
@@ -1565,7 +1571,7 @@ Source code for evergreen.api
timeout: Optional[int] = None,
log_on_error: bool = False,
) -> None:
- """Create an Evergreen Api object."""
+ """Create an Evergreen Api object."""
super(RetryingEvergreenApi, self).__init__(
api_server, auth, timeout, log_on_error=log_on_error
)
@@ -1579,9 +1585,13 @@ Source code for evergreen.api
reraise=True,
)
def _call_api(
- self, url: str, params: Dict = None, method: str = "GET", data: Optional[str] = None
+ self,
+ url: str,
+ params: Optional[Dict] = None,
+ method: str = "GET",
+ data: Optional[str] = None,
) -> requests.Response:
- """
+ """
Call into the evergreen api.
:param url: Url to call.
@@ -1609,19 +1619,19 @@ Source code for evergreen.api
Quick search
-
+
diff --git a/_modules/evergreen/api_requests.html b/_modules/evergreen/api_requests.html
index 66d1e3a3..1bc8a556 100644
--- a/_modules/evergreen/api_requests.html
+++ b/_modules/evergreen/api_requests.html
@@ -1,17 +1,19 @@
-
+
- evergreen.api_requests — evergreen.py 3.6.19 documentation
-
-
-
+ evergreen.api_requests — evergreen.py 3.6.20 documentation
+
+
+
+
+
@@ -49,14 +51,14 @@ Source code for evergreen.api_requests
[docs]class IssueLinkRequest(NamedTuple):
- """Issue to add to a task annotation."""
+ """Issue to add to a task annotation."""
issue_key: str
url: str
confidence_score: Optional[float] = None
[docs] def as_dict(self) -> Dict[str, Any]:
- """Get a dictionary representation of the issue link."""
+ """Get a dictionary representation of the issue link."""
data: Dict[str, Any] = {"issue_key": self.issue_key, "url": self.url}
if self.confidence_score is not None:
data["confidence_score"] = self.confidence_score
@@ -64,14 +66,14 @@ Source code for evergreen.api_requests
[docs]class MetadataLinkRequest(NamedTuple):
- """Metadata Link to add to a task annotation."""
+ """Metadata Link to add to a task annotation."""
url: str
text: str
[docs]class SlackAttachmentField(BaseModel):
- """
+ """
Slack fields that get displayed in a table-like format.
title: The field title.
@@ -86,7 +88,7 @@ Source code for evergreen.api_requests
[docs]class SlackAttachment(BaseModel):
- """
+ """
An attachment to be sent using Slack.
title: The attachment title.
@@ -103,15 +105,15 @@ Source code for evergreen.api_requests
fields: Array of SlackAttachmentFields that get displayed in a table-like format.
"""
- title: Optional[str]
- title_link: Optional[str]
- text: Optional[str]
- fallback: Optional[str]
- mrkdwn_in: Optional[List[str]]
- color: Optional[str]
- author_name: Optional[str]
- author_icon: Optional[str]
- fields: Optional[List[SlackAttachmentField]]
+ title: Optional[str] = None
+ title_link: Optional[str] = None
+ text: Optional[str] = None
+ fallback: Optional[str] = None
+ mrkdwn_in: Optional[List[str]] = None
+ color: Optional[str] = None
+ author_name: Optional[str] = None
+ author_icon: Optional[str] = None
+ fields: Optional[List[SlackAttachmentField]] = None
@@ -130,19 +132,19 @@ Source code for evergreen.api_requests
Quick search
-
+
diff --git a/_modules/evergreen/base.html b/_modules/evergreen/base.html
index d91d3bd2..730a2c35 100644
--- a/_modules/evergreen/base.html
+++ b/_modules/evergreen/base.html
@@ -1,17 +1,19 @@
-
+
- evergreen.base — evergreen.py 3.6.19 documentation
-
-
-
+ evergreen.base — evergreen.py 3.6.20 documentation
+
+
+
+
+
@@ -59,7 +61,7 @@ Source code for evergreen.base
[docs]def evg_attrib(attrib_name: str, type_fn: Optional[Callable] = None) -> property:
- """
+ """
Create an attribute for the given evergreen property.
This creates an attribute for the class that looks up the value via json. It is used to
@@ -81,7 +83,7 @@ Source code for evergreen.base
[docs]def evg_datetime_attrib(attrib_name: str) -> property:
- """
+ """
Create a datetime attribute for the given evergreen property.
:param attrib_name: Name of attribute.
@@ -90,7 +92,7 @@ Source code for evergreen.base
[docs]def evg_short_datetime_attrib(attrib_name: str) -> property:
- """
+ """
Create a shortened datetime attribute for the given evergreen property.
:param attrib_name: Name of attribute.
@@ -99,7 +101,7 @@ Source code for evergreen.base
[docs]def evg_date_attrib(attrib_name: str) -> property:
- """
+ """
Create a date attribute for the given evergreen property.
:param attrib_name: Name of attribute.
@@ -108,16 +110,16 @@ Source code for evergreen.base
class _BaseEvergreenObject(object):
- """Common evergreen object."""
+ """Common evergreen object."""
def __init__(self, json: Dict[str, Any], api: "EvergreenApi") -> None:
- """Create an instance of an evergreen task."""
+ """Create an instance of an evergreen task."""
self.json = json
self._api = api
self._date_fields = None
def _is_field_a_date(self, item: str) -> bool:
- """
+ """
Determine if given field is a date.
:param item: field to check.
@@ -126,7 +128,7 @@ Source code for evergreen.base
return bool(self._date_fields and item in self._date_fields and self.json[item])
def __getattr__(self, item: str) -> Any:
- """Lookup an attribute if it exists."""
+ """Lookup an attribute if it exists."""
if item != "json" and item in self.json:
if self._is_field_a_date(item):
return parse_evergreen_datetime(self.json[item])
@@ -158,19 +160,19 @@ Source code for evergreen.base
Quick search
-
+
diff --git a/_modules/evergreen/build.html b/_modules/evergreen/build.html
index 7ad6fbe2..f43f45c8 100644
--- a/_modules/evergreen/build.html
+++ b/_modules/evergreen/build.html
@@ -1,17 +1,19 @@
-
+
- evergreen.build — evergreen.py 3.6.19 documentation
-
-
-
+ evergreen.build — evergreen.py 3.6.20 documentation
+
+
+
+
+
@@ -67,7 +69,7 @@ Source code for evergreen.build
[docs]class StatusCounts(_BaseEvergreenObject):
- """Representation of Evergreen StatusCounts."""
+ """Representation of Evergreen StatusCounts."""
succeeded = evg_attrib("succeeded")
failed = evg_attrib("failed")
@@ -78,7 +80,7 @@ Source code for evergreen.build
timed_out = evg_attrib("timed_out")
def __init__(self, json: Dict[str, Any], api: "EvergreenApi") -> None:
- """
+ """
Create a Status Counts object.
:param json: Json of status counts object.
@@ -88,7 +90,7 @@ Source code for evergreen.build
[docs]class Build(_BaseEvergreenObject):
- """Representation of an Evergreen build."""
+ """Representation of an Evergreen build."""
id = evg_attrib("_id")
project_id = evg_attrib("project_id")
@@ -113,7 +115,7 @@ Source code for evergreen.build
origin = evg_attrib("origin")
def __init__(self, json: Dict[str, Any], api: "EvergreenApi") -> None:
- """
+ """
Create an instance of an evergreen task.
:param json: Json of build object.
@@ -123,11 +125,11 @@ Source code for evergreen.build
@property
def status_counts(self) -> StatusCounts:
- """Get the status counts of the build."""
+ """Get the status counts of the build."""
return StatusCounts(self.json["status_counts"], self._api)
[docs] def get_project_identifier(self) -> str:
- """
+ """
Return the human-readable project id. Can also be accessed as an attribute.
:return: Human-readable project id.
@@ -135,7 +137,7 @@ Source code for evergreen.build
return self.project_identifier
[docs] def get_tasks(self, fetch_all_executions: bool = False) -> List["Task"]:
- """
+ """
Get all tasks for this build.
:param fetch_all_executions: fetch all executions for tasks.
@@ -144,15 +146,15 @@ Source code for evergreen.build
return self._api.tasks_by_build(self.id, fetch_all_executions)
[docs] def is_completed(self) -> bool:
- """
+ """
Determine if this build has completed running tasks.
:return: True if build has completed running tasks.
"""
return self.status in COMPLETED_STATES
-[docs] def get_metrics(self, task_filter_fn: Callable = None) -> Optional[BuildMetrics]:
- """
+[docs] def get_metrics(self, task_filter_fn: Optional[Callable] = None) -> Optional[BuildMetrics]:
+ """
Get metrics for the build.
Metrics are only available on build that have finished running..
@@ -166,7 +168,7 @@ Source code for evergreen.build
return None
[docs] def get_version(self) -> "Version":
- """
+ """
Get the version this build is a part of.
:return: Version that this build is a part of.
@@ -174,7 +176,7 @@ Source code for evergreen.build
return self._api.version_by_id(self.version)
def __repr__(self) -> str:
- """
+ """
Get a string representation of Task for debugging purposes.
:return: String representation of Task.
@@ -198,19 +200,19 @@ Source code for evergreen.build
Quick search
-
+
diff --git a/_modules/evergreen/commitqueue.html b/_modules/evergreen/commitqueue.html
index 30b6bbf8..8991df25 100644
--- a/_modules/evergreen/commitqueue.html
+++ b/_modules/evergreen/commitqueue.html
@@ -1,17 +1,19 @@
-
+
- evergreen.commitqueue — evergreen.py 3.6.19 documentation
-
-
-
+ evergreen.commitqueue — evergreen.py 3.6.20 documentation
+
+
+
+
+
@@ -55,13 +57,13 @@ Source code for evergreen.commitqueue
[docs]class CommitQueueItem(_BaseEvergreenObject):
- """Representation of an entry in a commit queue."""
+ """Representation of an entry in a commit queue."""
issue = evg_attrib("issue")
modules = evg_attrib("modules")
def __init__(self, json: Dict[str, Any], api: "EvergreenApi") -> None:
- """
+ """
Create a CommitQueueItem object.
:param json: Commit queue item json.
@@ -71,12 +73,12 @@ Source code for evergreen.commitqueue
[docs]class CommitQueue(_BaseEvergreenObject):
- """Representation of a commit queue from evergreen."""
+ """Representation of a commit queue from evergreen."""
queue_id = evg_attrib("queue_id")
def __init__(self, json: Dict[str, Any], api: "EvergreenApi") -> None:
- """
+ """
Create an instance of a commit queue from evergreen json.
:param json: Evergreen json representation of commit queue.
@@ -86,7 +88,7 @@ Source code for evergreen.commitqueue
@property
def queue(self) -> List[CommitQueueItem]:
- """
+ """
Retrieve the queue for this commit queue.
:return: Queue of commits in the commit queue.
@@ -112,19 +114,19 @@ Source code for evergreen.commitqueue
Quick search
-
+
diff --git a/_modules/evergreen/config.html b/_modules/evergreen/config.html
index 8ba9a470..8e74df2d 100644
--- a/_modules/evergreen/config.html
+++ b/_modules/evergreen/config.html
@@ -1,17 +1,19 @@
-
+
- evergreen.config — evergreen.py 3.6.19 documentation
-
-
-
+ evergreen.config — evergreen.py 3.6.20 documentation
+
+
+
+
+
@@ -63,7 +65,7 @@ Source code for evergreen.config
[docs]def read_evergreen_from_file(filename: str) -> Dict:
- """
+ """
Read evergreen config from given filename.
:param filename: Filename to read config.
@@ -74,7 +76,7 @@ Source code for evergreen.config
[docs]def read_evergreen_config() -> Optional[Dict]:
- """
+ """
Search known location for the evergreen config file.
:return: First found evergreen configuration.
@@ -85,7 +87,7 @@ Source code for evergreen.config
[docs]def get_auth_from_config(config: Dict) -> EvgAuth:
- """
+ """
Get the evergreen authentication from the specified config dict.
:param config: Evergreen configuration.
@@ -95,7 +97,7 @@ Source code for evergreen.config
[docs]def get_auth() -> Optional[EvgAuth]:
- """
+ """
Get the evergreen authentication object from the default locations. Convenience function.
:return: Authentication information for evergreen.
@@ -122,19 +124,19 @@ Source code for evergreen.config
Quick search
-
+
diff --git a/_modules/evergreen/distro.html b/_modules/evergreen/distro.html
index ddd551b8..78a621e9 100644
--- a/_modules/evergreen/distro.html
+++ b/_modules/evergreen/distro.html
@@ -1,17 +1,19 @@
-
+
- evergreen.distro — evergreen.py 3.6.19 documentation
-
-
-
+ evergreen.distro — evergreen.py 3.6.20 documentation
+
+
+
+
+
@@ -60,14 +62,14 @@ Source code for evergreen.distro
[docs]class MountPoint(_BaseEvergreenObject):
- """Representation of Mount Point in distro settings."""
+ """Representation of Mount Point in distro settings."""
device_name = evg_attrib("device_name")
size = evg_attrib("size")
virtual_name = evg_attrib("virtual_name")
def __init__(self, json: Dict[str, Any], api: "EvergreenApi") -> None:
- """
+ """
Create an instance of the mount point.
:param json: Json of mount point.
@@ -77,10 +79,10 @@ Source code for evergreen.distro
[docs]class StaticDistroSettings(_BaseEvergreenObject):
- """Representation of Evergreen static distro settings."""
+ """Representation of Evergreen static distro settings."""
def __init__(self, json: Dict[str, Any], api: "EvergreenApi") -> None:
- """
+ """
Create an instance of the distro settings for static images.
:param json: Json of distro settings.
@@ -90,7 +92,7 @@ Source code for evergreen.distro
@property
def hosts(self) -> List[str]:
- """
+ """
Retrieve Hosts of static distro.
:return: hosts of static distro.
@@ -101,12 +103,12 @@ Source code for evergreen.distro
[docs]class DockerDistroSettings(_BaseEvergreenObject):
- """Representation of docker distro settings."""
+ """Representation of docker distro settings."""
image_url = evg_attrib("image_url")
def __init__(self, json: Dict[str, Any], api: "EvergreenApi") -> None:
- """
+ """
Create an instance of the distro settings for docker.
:param json: Json of distro settings.
@@ -116,7 +118,7 @@ Source code for evergreen.distro
[docs]class AwsDistroSettings(_BaseEvergreenObject):
- """Representation of AWS Distro Settings."""
+ """Representation of AWS Distro Settings."""
ami = evg_attrib("ami")
aws_access_key_id = evg_attrib("aws_access_key_id")
@@ -134,7 +136,7 @@ Source code for evergreen.distro
vpc_name = evg_attrib("vpc_name")
def __init__(self, json: Dict[str, Any], api: "EvergreenApi") -> None:
- """
+ """
Create an instance of the distro settings.
:param json: Json of the distro settings.
@@ -144,7 +146,7 @@ Source code for evergreen.distro
@property
def mount_points(self) -> List[MountPoint]:
- """
+ """
Retrieve list of mount points for the distro.
:return: List of mount points.
@@ -155,7 +157,7 @@ Source code for evergreen.distro
[docs]class PlannerSettings(_BaseEvergreenObject):
- """Representation of planner settings."""
+ """Representation of planner settings."""
version = evg_attrib("version")
minimum_hosts = evg_attrib("minimum_hosts")
@@ -167,7 +169,7 @@ Source code for evergreen.distro
task_ordering = evg_attrib("task_ordering")
def __init__(self, json: Dict[str, Any], api: "EvergreenApi") -> None:
- """
+ """
Create an instance of planner settings for a distro.
:param json: planner settings json.
@@ -177,12 +179,12 @@ Source code for evergreen.distro
[docs]class FinderSettings(_BaseEvergreenObject):
- """Representation of finder settings."""
+ """Representation of finder settings."""
version = evg_attrib("version")
def __init__(self, json: Dict[str, Any], api: "EvergreenApi") -> None:
- """
+ """
Create an instance of finder settings for a distro.
:param json: finder settings json.
@@ -192,7 +194,7 @@ Source code for evergreen.distro
[docs]class Distro(_BaseEvergreenObject):
- """Representation of an Evergreen Distro."""
+ """Representation of an Evergreen Distro."""
_PROVIDER_MAP = {
AWS_ON_DEMAND_PROVIDER: AwsDistroSettings,
@@ -225,7 +227,7 @@ Source code for evergreen.distro
container_pool = evg_attrib("container_pool")
def __init__(self, json: Dict[str, Any], api: "EvergreenApi") -> None:
- """
+ """
Create an instance of a distro.
:param json: Json of a distro.
@@ -236,7 +238,7 @@ Source code for evergreen.distro
@property
def settings(self) -> Optional[Any]:
- """
+ """
Retrieve the settings for the distro.
:return: settings for distro.
@@ -249,7 +251,7 @@ Source code for evergreen.distro
@property
def expansions(self) -> Optional[Dict[str, str]]:
- """
+ """
Retrieve dict of expansions for distro.
:return: dict of expansions.
@@ -260,7 +262,7 @@ Source code for evergreen.distro
@property
def planner_settings(self) -> PlannerSettings:
- """
+ """
Retrieve planner settings for distro.
:return: planner settings.
@@ -269,7 +271,7 @@ Source code for evergreen.distro
@property
def finder_settings(self) -> FinderSettings:
- """
+ """
Retrieve finder settings for distro.
:return: finder settings.
@@ -293,19 +295,19 @@ Source code for evergreen.distro
Quick search
-
+
diff --git a/_modules/evergreen/errors/exceptions.html b/_modules/evergreen/errors/exceptions.html
index fe6a1803..94c8b840 100644
--- a/_modules/evergreen/errors/exceptions.html
+++ b/_modules/evergreen/errors/exceptions.html
@@ -1,17 +1,19 @@
-
+
- evergreen.errors.exceptions — evergreen.py 3.6.19 documentation
-
-
-
+ evergreen.errors.exceptions — evergreen.py 3.6.20 documentation
+
+
+
+
+
@@ -50,10 +52,10 @@ Source code for evergreen.errors.exceptions
[docs]class EvergreenException(Exception):
- """An exception coming from the evergreen client."""
+ """An exception coming from the evergreen client."""
def __init__(self, msg: Optional[str] = None) -> None:
- """
+ """
Create a new exception instance.
:param msg: Message describing exception.
@@ -65,10 +67,10 @@ Source code for evergreen.errors.exceptions
[docs]class MetricsException(EvergreenException):
- """An exception with metrics collection."""
+ """An exception with metrics collection."""
def __init__(self, msg: Optional[str] = None) -> None:
- """
+ """
Create a new exception instance.
:param msg: Message describing exception.
@@ -80,10 +82,10 @@ Source code for evergreen.errors.exceptions
[docs]class ActiveTaskMetricsException(MetricsException):
- """An exception when a task is in progress during metrics collection."""
+ """An exception when a task is in progress during metrics collection."""
def __init__(self, task: "Task", msg: Optional[str] = None) -> None:
- """
+ """
Create a new exception instance.
:param task: Task in progress.
@@ -113,19 +115,19 @@ Source code for evergreen.errors.exceptions
Quick search
-
+
diff --git a/_modules/evergreen/host.html b/_modules/evergreen/host.html
index 9f852a10..a0c75358 100644
--- a/_modules/evergreen/host.html
+++ b/_modules/evergreen/host.html
@@ -1,17 +1,19 @@
-
+
- evergreen.host — evergreen.py 3.6.19 documentation
-
-
-
+ evergreen.host — evergreen.py 3.6.20 documentation
+
+
+
+
+
@@ -57,14 +59,14 @@ Source code for evergreen.host
[docs]class HostDistro(_BaseEvergreenObject):
- """Representation of a distro."""
+ """Representation of a distro."""
distro_id = evg_attrib("distro_id")
provider = evg_attrib("provider")
image_id = evg_attrib("image_id")
def __init__(self, json: Dict[str, Any], api: "EvergreenApi") -> None:
- """
+ """
Create an instance of a distro.
:param json: json of distro.
@@ -74,7 +76,7 @@ Source code for evergreen.host
[docs]class RunningTask(_BaseEvergreenObject):
- """Representation of a running task."""
+ """Representation of a running task."""
task_id = evg_attrib("task_id")
name = evg_attrib("name")
@@ -83,7 +85,7 @@ Source code for evergreen.host
build_id = evg_attrib("build_id")
def __init__(self, json: Dict[str, Any], api: "EvergreenApi") -> None:
- """
+ """
Create an instance of a Running Task.
:param json: json of running task.
@@ -92,7 +94,7 @@ Source code for evergreen.host
super(RunningTask, self).__init__(json, api)
[docs] def get_build(self) -> "Build":
- """
+ """
Get build for the running task.
:return: build object for task.
@@ -100,7 +102,7 @@ Source code for evergreen.host
return self._api.build_by_id(self.build_id)
[docs] def get_version(self) -> "Version":
- """
+ """
Get version for the running task.
:return: version object for task.
@@ -109,7 +111,7 @@ Source code for evergreen.host
[docs]class Host(_BaseEvergreenObject):
- """Representation of an Evergreen host."""
+ """Representation of an Evergreen host."""
host_id = evg_attrib("host_id")
host_url = evg_attrib("host_url")
@@ -121,21 +123,21 @@ Source code for evergreen.host
user_host = evg_attrib("user_host")
def __init__(self, json: Dict[str, Any], api: "EvergreenApi") -> None:
- """Create an instance of an evergreen host."""
+ """Create an instance of an evergreen host."""
super(Host, self).__init__(json, api)
@property
def running_task(self) -> RunningTask:
- """Get the running task on this host."""
+ """Get the running task on this host."""
return RunningTask(self.json["running_task"], self._api)
@property
def distro(self) -> HostDistro:
- """Get the distro on this host."""
+ """Get the distro on this host."""
return HostDistro(self.json["distro"], self._api)
[docs] def get_build(self) -> "Build":
- """
+ """
Get the build for the build using this host.
:return: build for task running on this host.
@@ -143,7 +145,7 @@ Source code for evergreen.host
return self.running_task.get_build()
[docs] def get_version(self) -> "Version":
- """
+ """
Get the version for the task using this host.
:return: version for task running on this host.
@@ -151,7 +153,7 @@ Source code for evergreen.host
return self.running_task.get_version()
def __str__(self) -> str:
- """Get a human readable string version of this host."""
+ """Get a human readable string version of this host."""
return "{host_id}: {distro_id} - {status}".format(
host_id=self.host_id, distro_id=self.distro.distro_id, status=self.status
)
@@ -173,19 +175,19 @@ Source code for evergreen.host
Quick search
-
+
diff --git a/_modules/evergreen/manifest.html b/_modules/evergreen/manifest.html
index 8a587ab4..3fed178e 100644
--- a/_modules/evergreen/manifest.html
+++ b/_modules/evergreen/manifest.html
@@ -1,17 +1,19 @@
-
+
- evergreen.manifest — evergreen.py 3.6.19 documentation
-
-
-
+ evergreen.manifest — evergreen.py 3.6.20 documentation
+
+
+
+
+
@@ -54,7 +56,7 @@ Source code for evergreen.manifest
[docs]class ManifestModule(_BaseEvergreenObject):
- """Represents a module in the evergreen manifest."""
+ """Represents a module in the evergreen manifest."""
branch = evg_attrib("branch")
repo = evg_attrib("repo")
@@ -63,7 +65,7 @@ Source code for evergreen.manifest
url = evg_attrib("url")
def __init__(self, name: str, json: Dict[str, Any], api: "EvergreenApi") -> None:
- """
+ """
Create an instance of an evergreen manifest module.
:param json: json representing manifest.
@@ -74,7 +76,7 @@ Source code for evergreen.manifest
[docs]class Manifest(_BaseEvergreenObject):
- """Representation of an evergreen manifest."""
+ """Representation of an evergreen manifest."""
id = evg_attrib("id")
revision = evg_attrib("revision")
@@ -82,7 +84,7 @@ Source code for evergreen.manifest
branch = evg_attrib("branch")
def __init__(self, json: Dict[str, Any], api: "EvergreenApi") -> None:
- """
+ """
Create an instance of an evergreen version manifest.
:param json: json representing manifest.
@@ -92,7 +94,7 @@ Source code for evergreen.manifest