U ~4i! @sddlZddlmZmZmZmZddlZddlmZddl m Z ddl Z ddl m Z ddlmZddlmZddlmZdd lmZdd lmZdd lTGd d d ejZedZeedddZGdddeZ dS)N)DictListOptionalIterator)wrapssleep)contextmanager) HTTPAdapter)Retry) HTTPStatus)Path)Jira)*c@seZdZddZdS)SensitiveDataFiltercCsbt|dr^d}|jdd}td||}td||}td||}td||}||_d SdS) Nmsgz\1***\2z\""z("username":\s*")[^"]*(")z("password":\s*")[^"]*(")z ("webSudoPassword":\s*")[^"]*(")z("atl_token":\s*")[^"]*(")T)hasattrrreplaceresub)selfrecordreplZ clean_msgr./modules/jira/api.pyfilters zSensitiveDataFilter.filterN)__name__ __module__ __qualname__rrrrrrsrzatlassian.rest_client皙?csfdd}|S)u- Декоратор для повторного выполнения функции через некоторое время, при возникновении ошибки. Использует экспоненциальный рост времени повтора(factor) до граничного времени ожидания(border_sleep_time) :param exception: исключения, которые отлавливаются :param start_sleep_time: начальное время повтора :param factor: во сколько раз нужно увеличить время ожидания :param border_sleep_time: граничное время ожидания :param max_attempts: максимальное количество попыток выполнения csNtfdd}tfdd}trJ|S|S)Nc ?s~d}}|d7}z||EdHWSk rv}z6|kr@||krN}n|d7}t|W5d}~XYqXqdSNrr!rargskwargsZattemptZtime_outerrorborder_sleep_time exceptionfactorfunc max_attemptsstart_sleep_timerr gen_retry.sz3backoff..retry_exception..gen_retryc sxd}}|d7}z ||WSk rp}z6|kr:||krH}n|d7}t|W5d}~XYqXqdSr$rr&r*rrretryBs z/backoff..retry_exception..retry)rinspectZisgeneratorfunction)r.r1r2r+r,r-r/r0)r.rretry_exception-s z backoff..retry_exceptionr)r,r0r-r+r/r5rr4rbackoff"s -r6csxeZdZdZfddZddZedddZfd d Zfd d Z fd dZ ddZ ddZ fddZ dddZddZdddZdeeddd Zdهfd!d" Zeed#d$Zeedeeed%d&d'Zdeedd(d)Zdeedd*d+Zd,d-Zd.d/Zd0d1Zdd2d3Z ed4d5d6Z!ed7d8d9Z"fd:d;Z#e$ed<d=d>Z%e$d?d@dAZ&de$eedCdDdEZ'de$eedFdGdHZ(fdIdJZ)dKdLZ*dMdNZ+fdOdPZ,ddQdRZ-e$dSdTdUZ.deeddVdWZ/ddXdYZ0ddZd[Z1dd\d]Z2d^d_Z3d`daZ4e5e$efddbdcZ6dddeZ7ddfdgZ8ddhdiZ9ddjdkZ:e$dldmdnZ;deddodpZfdudvZ?dwdxZ@fdydzZAfd{d|ZBfd}d~ZCfddZDfddZEddZFddZGddZHddZIddZJfddZKddZLddZMdeeedddZNde$e$e$dddZOddZPddZQddZRddZSddZTddZUdddZVe$edddZWddZXddZYddZZe$dddZ[e$eedddZ\e$dddZ]e$e$dddZ^e$dddZ_e$dddZ`de$e$e$e$edœddĄZadedddƄZbedddȄZcddʄZdfdd̄Zefdd΄ZffddЄZgdd҄ZhddԄZiZjS)JiraApidcs|dr|nd|}|dr2|d|d<n|d|d<d|krPd|d<d|krdt|d<tj|f||||d|_d |_d |_ dS) Nhttphttps://cloudtokenpasswordtimeout,ZsessionFzrest/auth/1/session) startswithgetcmfutilZrequests_sessionsuper__init___set_session_retriesr<_session_valid _session_url)rurlr'r( __class__rrrD`s   zJiraApi.__init__cCs@ttjtjtjdd}t|d}|jd||jd|dS)u Конфигурирует стратегию повторных попыток и ассоциирует ее с сессией r!)totalstatusZstatus_forcelistZbackoff_factorZ max_retrieshttp://r:N)r configZIMPORT_REQUEST_RETRY_TOTALZ!IMPORT_REQUEST_RETRY_STATUS_CODESr _sessionmount)rZretriesZ http_adapterrrrrEvs zJiraApi._set_session_retriesNc csi}tdd}dD]$}|jj|||<|j||q|j}|rH||_z |VW5|D],\}}|rx|j||q\|jj|dq\|r||_XdS)u< Временно отключает Retry. rrM)rNr:N)r rPZadaptersrArQr>itemspop)rr>Z old_adaptersZno_retry_adapterprefixZ old_timeoutZadapterrrr without_retrys   zJiraApi.without_retrycs|jrt||dS)u Переопределенный метод Базовая аутентификация устанавливается только для Jira Cloud N)r;rC_create_basic_session)rusernamer=rIrrrVszJiraApi._create_basic_sessioncs\|jr |jstd|jj|j|jd}tjd|j|d}|jjsRt dd|_ dS)u; Выполняет авторизацию u_Учетные данные для аутентификации не предоставлены)rWr=ZPOST)pathdatauRОшибка аутентификации: файлы cookie не полученыTN) rWr= ValueErrorrPcookiesclearrCrequestrG RuntimeErrorrF)rrYresponserIrr _authenticates  zJiraApi._authenticatecs>z tjd|jd}|jtjkWStjk r8YdSXdS)u~ Проверяет валидность текущей сессии через тестовый запрос GET)rXFN)rCr]rG status_coder ZOKrequestsRequestException)rr_rIrr_check_sessionszJiraApi._check_sessioncCs<|jjr(|js(|r(d|_|dS||dS)u> Создает валидную сессию TN)rPr[rFreuser_get_websudor`rrrr_create_valid_sessionszJiraApi._create_valid_sessioncCs|jjSN)rPr[rgrrrget_session_cookiesszJiraApi.get_session_cookiesc s|jrtj||SzJ|js$|tj||}|jtjkrZd|_|tj||}|WStj k r}zLt |dr|j dk r|j jtjkrd|_|tj||WYSW5d}~XYnXdS)u8 Переопределенный метод Используется только для Jira Server. Перед запросом проверяется валидность сессии и при необходимости выполняется авторизация Fr_N) r;rCr]rFrhrbr Z UNAUTHORIZEDrcrdrr_)rr'r(r_erIrrr]s,  zJiraApi.requestc Cs|p|j}|p|j}|jd||d|jj|d|||j|jd}td|d|j d|j | |j dd }t d |}|r|d p|d } nd } t|d "} |j|dD]} | | qW5QRXt|} | j} | | dW5QRSQRXdS)u Скачивает файл Args: download_url (_type_): url файла для скачивания save_path (_type_): путь для сохранения файла headers (_type_, optional): Заголовки. Defaults to None. timeout (_type_, optional): Таймаут. Defaults to None. chunk_size (_type_, optional): _description_. Defaults to 8*1024. ra)methodrHheadersT)streamrnr>Zverifyproxiesz HTTP: GET z ->  zContent-Dispositionz!filename\*?=(?:"([^"]+)"|([^;]+))r%r!wb) chunk_size) file_name file_sizeN)no_check_headersr>Zlog_curl_debugrPrAZ verify_sslrploggerdebugrbreasonZraise_for_statusrnrsearchgroupopenZ iter_contentwriter statst_size)rZ download_urlZ save_pathrnr>rtresZcontent_dispositionmatchrufchunkZ file_pathrvrrr download_file s6      zJiraApi.download_filecCsRd}|jdd}d}|jjr2|jj}|d}|r>||d<|j||g|jdS)u Получает веб-куки sudo Переопределенный метод, так как метод в родительском классе выполняется некорректно z%secure/admin/WebSudoAuthenticate.jspafalse)ZwebSudoPasswordZ webSudoIsPostNzatlassian.xsrf.token atl_token)rXrYfilesrn)r=rPr[Zget_dictrApostform_token_headers)rrHrYrr[rrrrf?s  zJiraApi.user_get_websudo*allrcCs0i}|dk rt||d<|dk rBt|tttfr:d|}||d<|dk rR||d<|dk rb||d<|dk rr||d<||jrdnd } g} |jr|pd |d <n t||d <|j| |d } | sq,| d} | | |dk rސq,|jr| drq,| d }qt| d} | t | |krq,|t | 7}q| S)u Переопределение метода jql_get_list_of_tickets класса Jira с учетом https://developer.atlassian.com/changelog/#CHANGE-2046 N maxResults,fieldsjqlexpand validateQuery search/jqlr{rrZ nextPageTokenstartAtparamsissuesisLastrK) int isinstancelisttuplesetjoin resource_urlr;rAextendlen)rrrstartlimitrvalidate_queryZnext_page_tokenrrHresultsr_rrKrrrjql_get_list_of_ticketsSsD      zJiraApi.jql_get_list_of_tickets)returnccs|dkrd}|jrd|}d}d}|p,|j}|j|||dd}|sHdS||7}|EdH|t|7}d|krz|kr.nq.dSq.dS)u( Получение всех задач Norder by created ASCzcreated > '1900-01-01' rZrenderedFields)rrrr)r; MAX_RESULTSrr)rrrstart_atrK max_resultsrrrr get_issuess(    zJiraApi.get_issuesc#sd}d}d}|p|j}tj||||dd}|ds8dS||7}t|d|d|dEdH|t|d7}d|kr|ksn||dkrdSqdS)Nrrchangelog,renderedFields)rrrru из rK)rrCget_issues_for_boardgryr)rboard_idrrrrKrrrIrrrs& "zJiraApi.get_issues_for_boardccsHd}d}|j|||d}|dgs&qD||7}|dD] }|Vq6qdS)Nr2rrrvalues)Zget_all_sprintrA)rrrrrrowrrr get_sprintss  zJiraApi.get_sprints)rrrc cszd|d}|pd|pdd}|r0d||d<|j||d}|d gsLqv|d |d 7<|d D] }|Vqhq0d S) u Возвращает все задачи в для заданного спринта. Включены только задачи, на просмотр которых у пользователя есть разрешение. Args: sprint_id (_type_): ID спринта start (int, optional): начальный индекс задач. Defaults to None. limit (int, optional): максимальное количество задач на странице. Defaults to None. fields (list, optional): необходимые поля задач. Defaults to None. Yields: dict: данные задачи zrest/agile/1.0/sprint/z/issuerrrrrrrrrrN)rrA) rZ sprint_idrrrrHrrrrrrget_sprint_issuess   zJiraApi.get_sprint_issuesccsd}|dkstdd|pd|d}|r0||d<|jr|d}|j||d}d |krbt|d |d snd S|d Ed H|d t|d 7<|r@|d |kr@d Sq@n|Ed Hd S) u Получение всех workflow https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows/#api-rest-api-3-workflow-search-get ztransitions,transitions.rules,transitions.properties,statuses,statuses.properties,default,schemes,projects,hasDraftWorkflow,operationsruGБольше 50 за раз запросить не получится!rrrrZ workflowNamezworkflow/searchr errorMessagesrNr)AssertionErrorr;rrA ExceptionrZget_all_workflows)rnamesrrrrHrrrr get_workflowss&  zJiraApi.get_workflowsccs|jr|d}d|p|jdd}|r.||d<|j||d}|dsHdS|dEdH|d t|d7<|r.|d |kr.dSq.n$|r||EdHn|EdHdS) u. Получение всех statuses zstatuses/searchrZusagesr projectIdrrNr)r;rrrArget_status_for_projectget_all_statuses)rr project_idrHrrrrr get_statuses s"  zJiraApi.get_statusescCs6d}d|i}|j||d}d|kr.t|d|dS)Nz!rest/api/3/workflowscheme/projectrrrrrAr)rrrHrrrrrget_project_scheme#s  zJiraApi.get_project_schemecCsd|d}||S)Nzrest/api/3/workflowscheme/z /workflowrAridurirrrget_issue_type_workflow_scheme+s z&JiraApi.get_issue_type_workflow_schemecCsd|}||S)Nzrest/api/3/issuetype/rrrrrget_issue_type/s zJiraApi.get_issue_typeccsd|p |jd}d}|j||d}d|kr6t|d|dsBdS|dEdH|dt|d7<|r|d|krdSqdS)Nrrzrest/api/3/workflowschemerrrr)rrArr)rrrrrrrrget_all_workflow_schemes3s z JiraApi.get_all_workflow_schemes) project_idsccsVdd|d}d}|j||d}|ds*dS|dEdH|dt|d7<qdS)Nrr)rrrz"rest/api/3/issuetypescheme/projectrrr)rAr)rrrrrrrrget_issue_type_schemesAs zJiraApi.get_issue_type_schemes)rcCsd|i}d}|j||dS)Nrzrest/api/3/issuetype/projectrr)rrrrrrrget_issue_for_projectKszJiraApi.get_issue_for_projectc#s|jrd}||EdHn~t}|d}|ddt}|rX|d|n |d|D]2ttfdd|d}|r|dd<VqfdS)Nzrest/api/3/issuetypejira.user.localeen_UKcs|ddkSNrr)Zitu issue_typerroz)JiraApi.get_issue_types..nameuntranslatedName) r;rArCget_issue_typesget_mypreferencesset_mypreferencesdelete_mypreferencesnextr)rr issue_typescurrent_user_localeZissue_types_untranslatedZissue_type_untranslatedrIrrrPs*       zJiraApi.get_issue_types) issue_keyrccsp|d}|d|d}tdddd}|j||d}|d sDd S|d Ed H|d t|d 7<q(d S) u@ Получим все комментарии по задаче issue/z/commentrrzrenderedBody,propertiesrrZcommentsNr)rdictrAr)rrbase_urlrHrrrrr get_commentsys  zJiraApi.get_comments)issue_id_or_keyccsv|d}|d|d}ddd}|j||d}|ds@d S|dEd H|d rXqr|d t|d7<q$d S) u? Получим историю изменений задачи rrz /changelogrr8rrrNrr)rrAr)rrrrHrrrrr get_changelogs  zJiraApi.get_changelogrrcCsd|d}|dkrdn||dkr&dn|d}g}|j||d}|dgsNq|||d|dk rfq||d |d 7<q2|S) u Возвращает все проекты, связанные с доской, для заданного идентификатора доски. Если у пользователя нет разрешения на просмотр доски, никакие проекты не будут возвращены вообще. Возвращаемые проекты упорядочены по названию. Args: board_id (str): id доски start (int, optional): начальная позиция выборки. Defaults to 0. limit (int, optional): максимальное количество возвращаемых элементов. Если указано None, то вернет все элементы. Defaults to 50. Returns: list: список проектов rest/agile/1.0/board/z/projectNrrrrrrr)rAr)rrrrrHrrresultrrrget_agile_board_projects  zJiraApi.get_agile_board_project project_keyrrcCsBd}i}|r||d<|r$t||d<|r4t||d<|j||dS)u Возвращает доски находящиеся в проекте Jira Cloud Args: project_key (_type_, optional): ключ или id проекта. Defaults to None. start (int, optional): начальная позиция выборки. Defaults to 0. limit (int, optional): максимальное количество возвращаемых элементов. Defaults to 50. Returns: _type_: _description_ zrest/agile/1.0/boardZprojectLocationrrr)rrA)rrrrrHrrrrget_project_boardss   zJiraApi.get_project_boardsc#sbd}d}|jr |j|||d}ntj|||d}|dgs@q^||7}|dD] }|VqPqdS)Nrrrr)r;rrCget_all_agile_boardsrArrrrrrrIrrrs  zJiraApi.get_all_agile_boardscCs0d}|j|d|id}||}||dd<|S)Nz3rest/greenhopper/1.0/rapidviewconfig/editmodel.jsonZ rapidViewIdrZcardColorConfig strategies)rA get_board_card_colors_strategies)rrrr_Zcard_colors_strategiesrrrget_advanced_board_settingss   z#JiraApi.get_advanced_board_settingsc Cspd|d}ddi}i}ddddg}|D]B}z(|d |}|j||d }|||<Wq(tk rhYq(Xq(|S) u Получает стратегии присвоения цветов карточкам Args: board_id (int | str): ID доски Returns: dict: стратегии цветов карточек z rest/greenhopper/1.0/cardcolors/z /strategyZ preloadValuestrueZ issuetypepriorityZassigneeZcustomrrr) rrrrrZstrategy_typesZ strategy_typerHr_rrrrs$  z(JiraApi.get_board_card_colors_strategiesc#sJd}d}tj|||d}|dgs(qF||7}|dD] }|Vq8qdS)Nrr)keyrrr)rCget_project_versions_paginatedrArrIrrr s  z&JiraApi.get_project_versions_paginatedccsp|d}d}d}t}|r$||d<||d<||d<|||}||dkrNql||7}|dD] }|Vq^q$dS) Nzauditing/recordriZ projectIdsoffsetrrKZrecords)rrrA)rrrHrrrrrrrrget_audit_recordss    zJiraApi.get_audit_records)rcCs||}|dS)u(Наблюдатели по задачеwatchers)Zissue_get_watchers)rrrrrr get_watchers&s zJiraApi.get_watchersc csddd}|r"|d|kr"||d<|jr2d}d}nd}|ps z!JiraApi.get_screen_scheme_actionscs"z tWSgYSXdSri)rCget_all_prioritiesrgrIrrr@s zJiraApi.get_all_prioritiescCsd|d}ddd}g}|j||d}d|kr.N)r/rrrr)rrgrrhrHrZproject_and_issue_typesZ issue_type_idrYr_rirjZworkflowrLrrlr get_simplified_project_workflows2s6   z(JiraApi.get_simplified_project_workflows)rc Csfd}d|i}z|j||dd}Wn>tjk r^}z|jjdkrJWY dS|W5d}~XYnX|jS)u Возвращает значение настройки текущего пользователя Args: key (str): ключ настройки Returns: _type_: значение rest/api/2/mypreferencesrT)rrrN)rArcrr_rbrK)rrrHrr_rrrrrgs    zJiraApi.get_mypreferences)rrYcCs"d}d|i}|j||i|ddS)u Устанавливает значение настройки текущего пользователя Args: key (str): ключ настройки data (str): значение настройки rnr)rYrrN)Zput)rrrYrHrrrrrszJiraApi.set_mypreferencescCs:d}d|i}z|j||dWntjk r4YnXdS)u Удаляет значение настройки текущего пользователя Args: key (str): ключ настройки rnrrN)deletercr)rrrHrrrrrs zJiraApi.delete_mypreferences)workflow_scheme_idcCsd|}||S)u Получает информацию о схеме бизнес-процессов Args: workflow_scheme_id (str): id схемы бизнес-процесса zrest/api/2/workflowscheme/r)rrprHrrrget_workflow_schemes zJiraApi.get_workflow_scheme)rrr0rrc Csx|d}i}|r||d<|r&||d<|r2||d<|r>||d<|jrb|}d|d|d<|j||d}|dS) u, Возвращает список разрешений, указывающий, какие разрешения есть у пользователя. Подробную информацию о разрешениях пользователя можно получить в глобальном контексте, контексте проекта или задачи Args: project_id (str, optional): ID проекта. Defaults to None. project_key (str, optional): Ключ проекта. Defaults to None. issue_id (str, optional): ID задачи. Defaults to None. issue_key (str, optional): Ключ задачи. Defaults to None. Returns: dict: Информация о разрешениях Z mypermissionsrrJZissueIdZissueKeyr permissionsr)rr;Zget_all_permissionsrr-rA) rrrr0rrHrZall_permissionsrrrrrget_permissionss zJiraApi.get_permissionscCsd}ddd}|r||d<ndddd d g}d ||d<g}|j||d }|d sVq||d |drnq|d|d7<q<|S)u2 Получает список всех фильтров из Jira Cloud Args: expand (str, optional): параметры для получения расширенных данных. Defaults to None. Returns: list: список фильтров zrest/api/2/filter/searchrrrrrowner descriptionZsharePermissionsZeditPermissionsrrrrrr)rrAr)rrrHrZ expand_listfiltersr_rrrget_all_filters_clouds,   zJiraApi.get_all_filters_cloudc Csddlm}d}dddddd}g}|j|||jdd}||d }|jd d d }|sVq|jd ddidD]`}|d} z|| } || Wqhtk r} zt d| d| W5d} ~ XYqhXqh|jdddsq|dd7<q$|S)u Получает список всех фильтров из Jira Server / Data Center В Jira Server / Data Center нет метода API для получения списка фильтров. Но можно получить ID фильтров через парсинг HTML-разметки страницы фильтров из раздела Администрирование > Система > Фильтры, и затем по ID фильтре получить информацию о нем через API. При указании параметров "decorator" и "contentOnly" в запросе, можно получить только необходимую часть HTML с таблицей списка фильтров и указателем пагинации. В таблице выводится по 20 фильтров на странице. Returns: list: список фильтров r) BeautifulSoupz+secure/admin/filters/ViewSharedFilters.jspaZnoneTr)Z decoratorZ contentOnlyZ sortColumnZ sortAscending pagingOffset)rrnrbZlxmltableZ mf_browse)rtrzdata-filter-id)Zattrsu2Ошибка получения фильтра id z: Naz icon-next)class_ryr%) Zbs4rxrArfindZfind_allZ get_filterr/rrxr)) rrxrHrrvr_ZsoupZ table_resultsZ filter_dataZ filter_idZfilter_rrrrget_all_filters_servers<    *zJiraApi.get_all_filters_servercCs|jr|S|SdS)u8 Получает все фильтры N)r;rwrrgrrrget_all_filters7szJiraApi.get_all_filtersc#st}|d}|ddt}|r<|d|n |d|D]2ttfdd|d}|rv|dd<VqJdS)uw Получает все решения Yields: dict: данные решения rrcs|ddkSrr)ruZ resolutionrrr[rz-JiraApi.get_all_resolutions..Nrr)rCget_all_resolutionsrrrrr)rZ resolutionsrZresolutions_untranslatedZresolution_untranslatedrIrrr@s$       zJiraApi.get_all_resolutionsc#st}|d}|ddt}|r<|d|n |d|D]2tfdd|Dd}|rv|dd<VqJdS)uw Получает все статусы Yields: dict: данные статуса rrc3s"|]}|ddkr|VqdSrNr.0Z untranslatedrLrr sz+JiraApi.get_all_statuses..Nrr)rCrrrrr)rriruntranslated_statusesuntranslated_statusrIrrres"       zJiraApi.get_all_statusesc#st|}|d}|ddt|}|r@|d|n |d|D]dtfdd|Dd}|rdD]4|d}tfdd|Dd}|rv|dd <qvVqNdS) u Получает все статусы проекта по типам задач Yields: dict: данные статуса rrc3s"|]}|ddkr|VqdSrrrrrrrsz1JiraApi.get_status_for_project..Nric3s"|]}|ddkr|VqdSrrrrrrrsrr)rCrrrrr)rrrrZuntranslated_issue_typesZuntranslated_issue_typerrrI)rrLrrs4        zJiraApi.get_status_for_projectcCsd|d}||S)u Ссылки проекта Args: project_key (str): код проекта Returns: list: список ссылок проекта zrest/projects/1.0/project/z /shortcutr)rrrHrrrget_project_shortcutss zJiraApi.get_project_shortcutscCsd}||S)u^ Возвращает данные о текущем пользователе zrest/api/2/myselfrrdrrr get_myselfszJiraApi.get_myself)N)NNrl)rrNNNN)Nr)r)NNN)Nr)rN)r)rr)Nrr)N)NN)N)N)N)rN)rrNNN)rNNN)NN)rr8)NN)F)NNNN)N)krrrrrDrEr rUrVr`rerhrjr]rrfrrrrrr6rrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrr$r&r'r(r)r+r1r2r3r4r5r6r9r:r<r;r>r@rCrErGrMrQrWrYr[r\r]r^r`rarcrerfrmrrrrqrsrwrrrrrrr __classcell__rrrIrr7]s      ' 6 ; %   ) $  ! +               (A"   5  (): % % / r7)r r!r"r#)!rtypingrrrrr3 functoolsrtimerrc contextlibr Zrequests.adaptersr Zurllib3.util.retryr r9r pathlibr Z atlassianrZ cmf.includeZloggingZFilterrZ getLoggerrxZ addFilterr6r7rrrrs"           ;