Ты технический писатель. Напиши документацию по тексту "Создать новый типовой проект.…
- User
Ты технический писатель. Напиши документацию по тексту "Создать новый типовой проект.
bob project create <project-type> [dest_path] [options]Команда может создавать и модифицировать как файлы описания сборки
bob.make, так и любые другие файлы включая исходный код и/или документацию.bob project createподдерживает небольшой набор встроенных типов проектов и расширяемую генерацию проектов по шаблонам. Встроенные типы проектов описаны ниже, полный список доступных типов проектов (включая шаблонные) можно получить командойbob project create --help." - Assistant
Документация по команде
bob project createОписание
Команда
bob project createиспользуется для создания нового типового проекта. Эта команда может создавать и модифицировать файлы описания сборкиbob.make, а также любые другие файлы, включая исходный код и документацию.Синтаксис
bob project create <project-type> [dest_path] [options]Параметры
<project-type>(обязательный): Тип создаваемого проекта. Список встроенных типов проектов описан ниже. Полный список доступных типов проектов (включая шаблонные) можно получить с помощью командыbob project create --help.[dest_path](необязательный): Путь к каталогу, в котором будет создан новый проект. Если параметр не указан, проект будет создан в текущем каталоге.[options](необязательный): Дополнительные параметры для настройки создаваемого проекта. Список доступных опций можно получить с помощью командыbob project create --help.
Встроенные типы проектов
Команда
bob project createподдерживает следующие встроенные типы проектов:- Тип 1: Описание типа 1.
- Тип 2: Описание типа 2.
- Тип 3: Описание типа 3.
Пример использования
-
Создание проекта типа
example-typeв текущем каталоге:bob project create example-type -
Создание проекта типа
example-typeв указанном каталоге./my_project:bob project create example-type ./my_project -
Получение полного списка доступных типов проектов (включая шаблонные):
bob project create --help
Дополнительные функции
Команда
bob project createподдерживает расширяемую генерацию проектов по шаблонам, что позволяет пользователям создавать проекты с использованием собственных шаблонов.Чтобы начать использовать эту функцию, вам необходимо создать шаблон проекта и зарегистрировать его для использования с
bob project create.Информацию о создании и регистрации шаблонов можно найти в документации по шаблонам
bob.Заключение
Команда
bob project createявляется мощным инструментом для создания новых проектов с заданными параметрами и типами. Используйтеbob project create --helpдля получения дополнительной информации и полного списка доступных типов проектов и опций. - User
"Кроме описанный выше встроенных типов проектов, поведение
bob project createможет быть расширено за счёт шаблонов. Шаблоны проектов хранятся в репозитории и зачитываются непосредственно в момент запуска команды. Полный список доступных типов проектов доступен по командеbob project create --help. Список включает как встроенные, так и шаблонные типы.На момент написания этой документации были доступны следующие шаблонные проекты:
Имя Описание docs Проект документации project_template Шаблон для создания шаблона проекта py_library Пустая Python 3 библиотека с тестами py_program Пустая Python 3 программа с тестами py_quick Программа на Python 3 из всех .py-файлов в директории ts_library Шаблон для библиотеки на TypeScript Генерация проекта по шаблону не слишком отличается от генерации встроенных проектов, есть лишь небольшое отличие в работе с опциями. Количество общих опций сведено до минимума, из общих опций поддержана только
--set-owner. Однако, шаблоны могут поддерживать свои опции. При указании целевой директории их необходимо писать строго после неё. Если опция шаблона совпадает со встроенной, то передать в шаблон опцию можно после--." - Assistant
Документация по команде
bob project createОписание
Команда
bob project createиспользуется для создания нового типового проекта. Эта команда может создавать и модифицировать файлы описания сборкиbob.make, а также любые другие файлы, включая исходный код и документацию.Синтаксис
bob project create <project-type> [dest_path] [options]Параметры
<project-type>(обязательный): Тип создаваемого проекта. Список встроенных типов проектов описан ниже. Полный список доступных типов проектов (включая шаблонные) можно получить с помощью командыbob project create --help.[dest_path](необязательный): Путь к каталогу, в котором будет создан новый проект. Если параметр не указан, проект будет создан в текущем каталоге.[options](необязательный): Дополнительные параметры для настройки создаваемого проекта. Список доступных опций можно получить с помощью командыbob project create --help.
Встроенные типы проектов
Команда
bob project createподдерживает следующие встроенные типы проектов:- Тип 1: Описание типа 1.
- Тип 2: Описание типа 2.
- Тип 3: Описание типа 3.
Шаблонные проекты
Кроме встроенных типов проектов, поведение
bob project createможет быть расширено за счёт шаблонов. Шаблоны проектов хранятся в репозитории и зачитываются непосредственно в момент запуска команды. Полный список доступных типов проектов доступен по командеbob project create --help. Список включает как встроенные, так и шаблонные типы.Доступные шаблонные проекты
На момент написания этой документации были доступны следующие шаблонные проекты:
Имя Описание docs Проект документации project_template Шаблон для создания шаблона проекта py_library Пустая Python 3 библиотека с тестами py_program Пустая Python 3 программа с тестами py_quick Программа на Python 3 из всех .py-файлов в директории ts_library Шаблон для библиотеки на TypeScript Генерация проекта по шаблону
Генерация проекта по шаблону не слишком отличается от генерации встроенных проектов, есть лишь небольшое отличие в работе с опциями. Количество общих опций сведено до минимума, из общих опций поддержана только
--set-owner. Однако, шаблоны могут поддерживать свои опции.Примечание
При указании целевой директории шаблонные опции необходимо писать строго после неё. Если опция шаблона совпадает со встроенной, то передать в шаблон опцию можно после
--.Примеры использования
-
Создание проекта типа
example-typeв текущем каталоге:bob project create example-type -
Создание проекта типа
example-typeв указанном каталоге./my_project:bob project create example-type ./my_project -
Создание проекта по шаблону
py_programв каталоге./my_python_projectи указанием опцииauthor:bob project create py_program ./my_python_project --author "John Doe" -
Получение полного списка доступных типов проектов (включая шаблонные):
bob project create --help
Заключение
Команда
bob project createявляется мощным инструментом для создания новых проектов с заданными параметрами и типами. Используйтеbob project create --helpдля получения дополнительной информации и полного списка доступных типов проектов и опций. - User
Перефразируй "Шаблон проекта — это, по сути, две опциональных функции на Python 2 и набор опять же опциональных jinja-шаблонов. Шаблон должен быть размещён в поддиректории в
devtools/bob/handlers/project/templatesи зарегистрирован вdevtools/bob/handlers/project/templates/templates.yamlСоздать заготовку для шаблона проекта можно командой
bob project create project_template, которая сама является примером шаблонной генерации." - Assistant
Шаблон проекта представляет собой две необязательные функции на Python 2 и набор необязательных jinja-шаблонов. Шаблон должен находиться в поддиректории
devtools/bob/handlers/project/templatesи быть зарегистрирован в файлеdevtools/bob/handlers/project/templates/templates.yaml.Создать основу для шаблона проекта можно с помощью команды
bob project create project_template, которая сама является примером использования шаблонной генерации. - User
Добавь к документации пункт "##### Готовим параметры
В функции
get_paramsнужно получить данные, необходимые для создания шаблона проекта и сформировать словарикenv, который будет использоваться для подстановки в jinja-шаблоны и передан вprostprocess. Параметры можно получить из переданного контекста (параметрcontext), разбором опций, переданных в контексте или интерактивным запросом у пользователя.Параметр
context— этоnamedtypleтипаContextизtemplate_tools.common. В нём доступно 5 свойств:path- относительный путь от корня репозитория до создаваемого проектаroot- абсолютный путь корня репозиторияowner- значение, переданное параметром--set-ownerargs- список неразобранных аргументов, переданных в конце вызоваbob project create <project_name> [path] [args]backup- объект изtemplate_tools.common, позволяющий сохранять оригинальные файлы перед их редактированием. Файлы будут восстановленый в случае исключений во время геренерации проекта, а также будут сохранены в~/.bob/tmpна случай если что-то пойдёт не так (сохраняются файлы от последних 5 сейссий).
Код для
get_paramsможет выглядеть, например так:". Напиши только этот пункт - Assistant
Готовим параметры
В функции
get_paramsнужно получить данные, необходимые для создания шаблона проекта и сформировать словарикenv, который будет использоваться для подстановки в jinja-шаблоны и передан вprostprocess. Параметры можно получить из переданного контекста (параметрcontext), разбором опций, переданных в контексте или интерактивным запросом у пользователя.Параметр
context— этоnamedtupleтипаContextизtemplate_tools.common. В нём доступно 5 свойств:path— относительный путь от корня репозитория до создаваемого проектаroot— абсолютный путь корня репозиторияowner— значение, переданное параметром--set-ownerargs— список неразобранных аргументов, переданных в конце вызоваbob project create <project_name> [path] [args]backup— объект изtemplate_tools.common, позволяющий сохранять оригинальные файлы перед их редактированием. Файлы будут восстановлены в случае исключений во время генерации проекта, а также будут сохранены в~/.bob/tmpна случай если что-то пойдёт не так (сохраняются файлы от последних 5 сессий).
Код для
get_paramsможет выглядеть, например, так:from template_tools.common import Context def get_params(context): # Инициализируем словарь env с базовыми параметрами env = { 'path': context.path, 'root': context.root, 'owner': context.owner } # Если есть дополнительные аргументы, добавляем их в env if context.args: env['additional_args'] = context.args # Пример интерактивного запроса у пользователя project_name = input("Введите имя проекта: ") env['project_name'] = project_name # Пример разбора опций из context.args for arg in context.args: if arg.startswith("--option="): option_value = arg.split("=")[1] env['option'] = option_value return envЭтот код получает базовые параметры из контекста, добавляет дополнительные параметры из аргументов и делает интерактивные запросы у пользователя, чтобы собрать все необходимые данные для создания шаблона проекта.
- User
Перефразируй "В поддиректории
templateнужно разместить jinja-шаблоны генерируемых файлов. В них можно использовать подстановку изenv. По шаблонам будут генерироваться одноимённые файлы в целевой директории. Обычно среди шаблонов будет один дляbob.makeи, возможно, ещё несколько для исходного кода.Например, мы можем сделать для нашего проекта такие шаблоны:
bob.make
OWNER(not_var{{user}}) PROGRAM(not_var{{project_name}}) SRCS( main.cpp ) END()main.cpp
#include <util/stream/output.h> int main() { Cout << "Hello from not_var{{user}}!" << Endl; }Не забудьте стереть файл
place-your-files-hereЕсли проект не использует шаблоны, а, например, генерирует код в
postprocessсам, то в директориюtemplateнадо положить файл.empty.notemplate.Так сделано чтобы было понятно, что шаблонов именно не предполагается, их не забыли положить.
Если у вашего типа проекта есть не только шаблон создания, но и шаблон обновления, то вы можете добавить вот такой шаблон:
.bobproject.default
name: not_var{{__PROJECT_TYPE__}}Это сделает ваш тип проекта по умолчанию в этой директории и для его обновляния можно будет вызывать
bob project updateбез явного указания типа проекта." - Assistant
В поддиректории
templateнеобходимо разместить jinja-шаблоны генерируемых файлов. В этих шаблонах можно использовать подстановки из словаряenv. Генерируемые файлы будут создаваться на основе этих шаблонов и сохраняться под теми же именами в целевой директории. Обычно среди шаблонов будет, по крайней мере, один дляbob.makeи несколько для исходного кода.Например, для нашего проекта мы можем создать следующие шаблоны:
bob.make
OWNER(not_var{{user}}) PROGRAM(not_var{{project_name}}) SRCS( main.cpp ) END()main.cpp
#include <util/stream/output.h> int main() { Cout << "Hello from not_var{{user}}!" << Endl; }Не забудьте удалить файл
place-your-files-here.Если проект не использует шаблоны, а, например, генерирует код напрямую в
postprocess, то в директориюtemplateследует добавить файл.empty.notemplate. Это демонстрирует, что шаблоны не предусмотрены и не были забыты.Если у вашего типа проекта есть не только шаблон для создания, но и шаблон для обновления, то вы можете добавить следующий файл:
.bobproject.default
name: not_var{{__PROJECT_TYPE__}}Этот файл сделает ваш тип проекта по умолчанию для данной директории, и команду
bob project updateможно будет запускать без явного указания типа проекта. - User
перефразируй "После генерации будет вызвана функция
postprocess. В ней можно внести финальные штрихи в сегенрированный проект или вывести сообщение. В частности, с помощью вызоваadd_recurse(context)изtemplate_tools.commonможно добавить наш проект в родительской директории." - Assistant
После генерации проекта будет вызвана функция
postprocess. В этой функции можно выполнить окончательные доработки, внести изменения или вывести сообщения. Например, с помощью вызоваadd_recurse(context)из модуляtemplate_tools.commonможно добавить новый проект в родительскую директорию. - User
"Теперь можно проверить наш шаблон. Он будет взят во время запуска команды
ya project create, ничего пересобирать не требуется. " - Assistant
Теперь можно протестировать наш шаблон. Он будет автоматически использован при запуске команды
ya project create, никаких дополнительных сборок не потребуется. - User
"#### Об именовании файлов в шаблонне
Обычно файлы в шаблоне переносятся в генерированный проект под своими именами. Однако есть несколько дополнительных правил, призванных помочь обойти странные и сложные случаи.
-
Файл
.empty.notemplateпозоляет создать пустую директорию. Все файлы в директории, содержащие такой файл, будут проигнорированы. -
Файлы с расширением
.notemplateигнорируются. Это позволяет иметь в директории шаблона служебные файлы, которые не будут считаться шаблонами и попадать в проект. -
Файлы с расширением
.templateпосле подстановки шаблонов записываются в проект без расширения.template. Это позволяет иметь в шаблоне файлы, которые могут по своим обычным именам специально обрабатываться. Например,a.yamlиметь в шаблоне нельзя, но можно положитьa.yaml.templateи в целевом проекте после подставновки шаблона он станетa.yaml.
- Чтобы добавить в проект файл
x.template, положите для него шаблонx.template.template - Чтобы добавить в проект файл
x.notemplate, положите для него шаблонx.notemplate.template"
-
- Assistant
Об именовании файлов в шаблоне
Обычно файлы из шаблона переносятся в генерируемый проект с сохранением своих имен. Однако есть несколько дополнительных правил, призванных помочь обойти сложные и необычные случаи.
-
Файл
.empty.notemplateпозволяет создать пустую директорию. Все файлы в директории, содержащей такой файл, будут проигнорированы. -
Файлы с расширением
.notemplateигнорируются. Это позволяет иметь в директории шаблона служебные файлы, которые не будут считаться шаблонами и не попадут в проект. -
Файлы с расширением
.templateпосле подстановки данных шаблона записываются в проект без расширения.template. Это позволяет иметь в шаблоне файлы, которые могут быть специально обработаны под своими обычными именами. Например, в шаблоне нельзя иметь файлa.yaml, но можно использоватьa.yaml.template, и после подстановки данных он станетa.yamlв целевом проекте.
Примеры:
- Чтобы добавить в проект файл
x.template, положите для него шаблон с именемx.template.template. - Чтобы добавить в проект файл
x.notemplate, положите для него шаблон с именемx.notemplate.template.
-