Watchdocs

class plate.watchdocs.document_trace_handler.DocumentTraceHandler(tracing_files=None)

DocumentTraceHandler is event handler for API Document files.

on_modified(event)

Event handler about modified. If raise modify on api document file or index file such as index.json, enqueue event to DocumentTraceQueue.

Parameters:event – the event about event handler

class plate.watchdocs.document_trace_queue.DocumentTraceQueue

Queue of modification, inserted, deleted document.

clear()

Remove all trace_queue

count()

Count of trace_queue

Returns:count

dequeue()

Dequeue event Return the copy of top event in trace_queue

Returns:event

enqueue(event, is_index_file)

Enqueue event to trace_queue

Parameters:

• event – insert/update/del event
• is_index_file – True or False

is_empty()

Is empty trace_queue?

Returns:True or False

class plate.watchdocs.api_document_observer.APIDocumentObserver(doc_path=None, doc_index_path=None, doc_file_path_list=None)

APIDocumentObserver is observer of API Documents.

is_started

After run start_watch(), is_started is True, or False.

Returns:True | False

start_watch()

Start watch docs

stop_watch()

Stop watch docs

class plate.watchdocs.document_trace_file.DocumentTraceFile(tracing_file_path, is_index_file=False)