def test_write_valid(self): sample_markdown = '# Sample Title\nThis is a paragraph.\n' expected_string = sample_markdown generic_directory = unittest_file_path('test_generic') file_name = 'blowdry' extensions = ['.md', '.rst', '.html', '.txt', ] for extension in extensions: generic_file = GenericFile(file_directory=generic_directory, file_name=file_name, extension=extension) if path.isfile(generic_file.file_path): # Ensure that file is deleted before testing. remove(generic_file.file_path) generic_file.write(text=str(sample_markdown)) with open(generic_file.file_path, 'r') as generic_file: file_string = generic_file.read() self.assertEqual(file_string, expected_string)
def boilerplate(): """ Watchdog wrapper only calls this once to eliminate recurring performance impact. - Generate Markdown documentation files. - Generate HTML documentation files. (This location is important since it allows encoded css to be included in the documentation files.) - Generate reStructuredText documentation files. :return: None """ if settings.logging_enabled: log.enable() if settings.hide_css_errors: cssutils.log.setLevel(logging.CRITICAL) # Generate Markdown documentation files. if settings.markdown_docs: markdown_file = GenericFile( # Document forbidden clashing aliases. file_directory=settings.markdown_directory, file_name='clashing_aliases', extension='.md' ) markdown_file.write(str(clashing_alias_markdown)) markdown_file = GenericFile( # Document allowed property aliases. file_directory=settings.markdown_directory, file_name='property_aliases', extension='.md' ) markdown_file.write(str(property_alias_markdown)) # Generate HTML documentation files. (This location is important since it allows encoded css to be included # in the documentation files.) if settings.html_docs: html_file = GenericFile( # Document forbidden clashing aliases. file_directory=settings.project_directory, file_name='clashing_aliases', extension='.html' ) html_file.write(str(clashing_alias_html)) html_file = GenericFile( # Document allowed property aliases. file_directory=settings.project_directory, file_name='property_aliases', extension='.html' ) html_file.write(str(property_alias_html)) # Generate reStructuredText documentation files. if settings.rst_docs: print('\nDocumentation Directory:', str(settings.docs_directory)) # str() is required for Python2 rst_file = GenericFile(file_directory=settings.docs_directory, file_name='clashing_aliases', extension='.rst') rst_file.write(str(clashing_alias_rst)) rst_file = GenericFile(file_directory=settings.docs_directory, file_name='property_aliases', extension='.rst') rst_file.write(str(property_alias_rst))