paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-09 16:37:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

bugdown/api_code_examples: Add macro for admin zuliprc lines.

Browse Source 
Some of our code examples can only be run with administrator
credentials (such as create-user). Thus, the Markdown extension
for generating code examples should have an option to include
the lines that recommend using an admin zuliprc instead of a
non-admin one.
This commit is contained in:
Eeshan Garg
2018-01-31 01:04:53 -03:30
committed by showell
parent 73a3755120
commit fe98a59f5c
1 changed files with 18 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
zerver/lib/bugdown/api_code_examples.py
View File

@@ -23,6 +23,16 @@ client = zulip.Client(config_file="~/zuliprc-dev")
""" """
PYTHON_CLIENT_ADMIN_CONFIG = """
#!/usr/bin/env python
import zulip
# You need a zuliprc-admin with administrator credentials
client = zulip.Client(config_file="~/zuliprc-admin")
"""
class APICodeExamplesGenerator(Extension): class APICodeExamplesGenerator(Extension):
def extendMarkdown(self, md: markdown.Markdown, md_globals: Dict[str, Any]) -> None: def extendMarkdown(self, md: markdown.Markdown, md_globals: Dict[str, Any]) -> None:
@@ -50,6 +60,8 @@ class APICodeExamplesPreprocessor(Preprocessor):
text = self.render_fixture(function) text = self.render_fixture(function)
elif key == 'method': elif key == 'method':
text = self.render_code_example(function) text = self.render_code_example(function)
elif key == 'method(admin_config=True)':
text = self.render_code_example(function, admin_config=True)
# The line that contains the directive to include the macro # The line that contains the directive to include the macro
# may be preceded or followed by text or tags, in that case # may be preceded or followed by text or tags, in that case
@@ -77,7 +89,7 @@ class APICodeExamplesPreprocessor(Preprocessor):
return fixture return fixture
def render_code_example(self, function: str) -> List[str]: def render_code_example(self, function: str, admin_config: Optional[bool]=False) -> List[str]:
method = zerver.lib.api_test_helpers.TEST_FUNCTIONS[function] method = zerver.lib.api_test_helpers.TEST_FUNCTIONS[function]
function_source_lines = inspect.getsourcelines(method)[0] function_source_lines = inspect.getsourcelines(method)[0]
ce_regex = re.compile(r'\# \{code_example\|\s*(.+?)\s*\}') ce_regex = re.compile(r'\# \{code_example\|\s*(.+?)\s*\}')
@@ -92,7 +104,11 @@ class APICodeExamplesPreprocessor(Preprocessor):
elif match.group(1) == 'end': elif match.group(1) == 'end':
end = function_source_lines.index(line) end = function_source_lines.index(line)
config = PYTHON_CLIENT_CONFIG_LINES.splitlines() if admin_config:
config = PYTHON_CLIENT_ADMIN_CONFIG.splitlines()
else:
config = PYTHON_CLIENT_CONFIG_LINES.splitlines()
snippet = function_source_lines[start + 1: end] snippet = function_source_lines[start + 1: end]
code_example = [] code_example = []