Documentation — api_module.py

load_and_visualize

• Загружает сохраненный ранее граф из заданного файла.

Объявление

• def load_and_visualize(pathTograph: String)

Параметры

1. pathTograph — путь к графу, по умолчанию PATH_TO_JSON_GRAPH PATH_TO_JSON_GRAPH = os.path.join(RESULTS_FOLDER_NAME,JSON_GRAPH_FILENAME) RESULTS_FOLDER_NAME = 'Results' JSON_GRAPH_FILENAME = 'graph.json'

process_period

• Выводит решения между заданными датами firstDate и lastDate.

Объявление

• def process_period( firstDateOfDocsForProcessing:date or str, lastDateOfDocsForProcessing:date or str, supertypesForProcessing: set(str), docTypesForProcessing:set(str), firstDateForNodes:date or str, lastDateForNodes:date or str, nodesIndegreeRange:tuple(int,int), nodesOutdegreeRange:tuple(int,int), nodesSupertypes:set(str), nodesTypes:set(str), includeIsolatedNodes:Bool, firstDateFrom:date or str, lastDateFrom:date or str, docTypesFrom:date or str, supertypesFrom:set(str), firstDateTo:date, lastDateTo:date, docTypesTo:set(str), supertypesTo:set(str), weightsRange:int, graphOutputFilePath:str, showPicture:Bool, takeHeadersFromLocalStorage:Bool, sendRequestToUpdatingHeadersInBaseFromSite:Bool, whichSupertypeUpdateFromSite:set(str))

Параметры

1. firstDateOfDocsForProcessing — начальная дата для обработки.
2. lastDateOfDocsForProcessing — конечная дата для обработки.
3. supertypesForProcessing — супертипы для обработки.
4. docTypesForProcessing — типы документов для обработки.
5. firstDateForNodes — начальная дата для нодов.
6. lastDateForNodes — конечная дата для нодов.
7. nodesIndegreeRange — диапозон внутренних нодов.
8. nodesOutdegreeRange — диапозон внешних нодов.
9. nodesSupertypes — супертипы нодов.
10. nodesTypes — типы нодов.
11. includeIsolatedNodes — включать ли изолированные ноды.
12. firstDateFrom — отсчет начальной даты.
13. lastDateFrom — отсчет конечной даты.
14. docTypesFrom — типы документов.
15. supertypesFrom — супертипы.
16. firstDateTo — конец начальной даты.
17. lastDateTo — конец конечной даты.
18. docTypesTo — типы документов.
19. supertypesTo — супертипы.
20. weightsRange — диапозон весов.
21. graphOutputFilePath — по умолчанию PATH_TO_JSON_GRAPH PATH_TO_JSON_GRAPH = os.path.join(RESULTS_FOLDER_NAME,JSON_GRAPH_FILENAME) RESULTS_FOLDER_NAME = 'Results' JSON_GRAPH_FILENAME = 'graph.json'
22. showPicture — показывать ли граф.
23. takeHeadersFromLocalStorage — брать ли заголовки из локального хранилища.
24. sendRequestToUpdatingHeadersInBaseFromSite — посылать ли запрос на обновление заголовков в базе данных с сайта.
25. whichSupertypeUpdateFromSite — какие супертипы обновлять с сайта.

Возвращает

1. jsonLinks - ссылки на решения и, если надо, рисует граф.

start_process_with

• Начинаем обрабатывать решения с указанного uid и повторяем это до указанной глубины рекурсии.

Объявление

• def start_process_with( decisionID:str, depth:int, firstDateForNodes:date or str, lastDateForNodes:date or str, nodesIndegreeRange:tuple(int,int), nodesOutdegreeRange:tuple(int,int), nodesSupertypes:set(str), nodesTypes:set(str), includeIsolatedNodes:Bool, firstDateFrom:date or str, lastDateFrom:date or str, docTypesFrom:set(str), supertypesFrom:set(str), firstDateTo:date or str, lastDateTo:date or str, docTypesTo:set(str), supertypesTo:set(str), weightsRange:tuple(int,int), graphOutputFilePath:str, showPicture:Bool, takeHeadersFromLocalStorage:Bool, sendRequestToUpdatingHeadersInBaseFromSite:Bool, whichSupertypeUpdateFromSite:set(str), visualizerParameters:(int, int, (int, int)))

Параметры

1. decisionID — номер решения.
2. depth — глубина рекурсии.
3. firstDateForNodes — начальная дата для нодов.
4. lastDateForNodes — конечная дата для нодов.
5. nodesIndegreeRange — диапозон внутренних нодов.
6. nodesOutdegreeRange — диапозон внешних нодов.
7. nodesSupertypes — супертипы нодов.
8. nodesTypes — типы нодов.
9. includeIsolatedNodes — включать ли изолированные ноды.
10. firstDateFrom — отсчет начальной даты.
11. lastDateFrom — отсчет конечной даты.
12. docTypesFrom — типы документов.
13. supertypesFrom — супертипы.
14. firstDateTo — конец начальной даты.
15. lastDateTo — конец конечной даты.
16. docTypesTo — типы документов.
17. supertypesTo — супертипы.
18. weightsRange — диапозон весов.
19. graphOutputFilePath — по умолчанию PATH_TO_JSON_GRAPH PATH_TO_JSON_GRAPH = os.path.join(RESULTS_FOLDER_NAME,JSON_GRAPH_FILENAME) RESULTS_FOLDER_NAME = 'Results' JSON_GRAPH_FILENAME = 'graph.json'
20. showPicture — показывать ли картинку.
21. takeHeadersFromLocalStorage — взять ли заголовки из локального хранилища.
22. sendRequestToUpdatingHeadersInBaseFromSite — посылать ли запрос на обновление заголовков в базе данных с сайта.
23. whichSupertypeUpdateFromSite — какой супертип обновлять с сайта.
24. visualizerParameters — параметры для visualizer, по умолчанию (20, 1, (40, 40)).

get_all_links_from_all_headers

• Получаем все ссылки из всех заголовков.

Объявление

• def get_all_links_from_all_headers( sendRequestToUpdatingHeadersInBaseFromSite:Bool, whichSupertypeUpdateFromSite:Bool)

Параметры

1. sendRequestToUpdatingHeadersInBaseFromSite — посылаем ли запрос на обновление заголовков с сайта.
2. whichSupertypeUpdateFromSite — обновляем ли супертип с сайта.

Возвращает

1. jsonLinks — ссылки на решения.