Skip to content
TheChatArchiveThe Chat Archive
gpt-4o-2024-05-13· OpenAIAi2 WildChat-4.8M (AI2)

Ты технический писатель. Напиши документацию по тексту "Создать новый типовой проект.…

  1. User

    Ты технический писатель. Напиши документацию по тексту "Создать новый типовой проект.

    bob project create <project-type> [dest_path] [options]

    Команда может создавать и модифицировать как файлы описания сборки bob.make, так и любые другие файлы включая исходный код и/или документацию.

    bob project create поддерживает небольшой набор встроенных типов проектов и расширяемую генерацию проектов по шаблонам. Встроенные типы проектов описаны ниже, полный список доступных типов проектов (включая шаблонные) можно получить командой bob project create --help."

  2. 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: Описание типа 1.
    2. Тип 2: Описание типа 2.
    3. Тип 3: Описание типа 3.

    Пример использования

    1. Создание проекта типа example-type в текущем каталоге:

      bob project create example-type
      
    2. Создание проекта типа example-type в указанном каталоге ./my_project:

      bob project create example-type ./my_project
      
    3. Получение полного списка доступных типов проектов (включая шаблонные):

      bob project create --help
      

    Дополнительные функции

    Команда bob project create поддерживает расширяемую генерацию проектов по шаблонам, что позволяет пользователям создавать проекты с использованием собственных шаблонов.

    Чтобы начать использовать эту функцию, вам необходимо создать шаблон проекта и зарегистрировать его для использования с bob project create.

    Информацию о создании и регистрации шаблонов можно найти в документации по шаблонам bob.

    Заключение

    Команда bob project create является мощным инструментом для создания новых проектов с заданными параметрами и типами. Используйте bob project create --help для получения дополнительной информации и полного списка доступных типов проектов и опций.

  3. 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. Однако, шаблоны могут поддерживать свои опции. При указании целевой директории их необходимо писать строго после неё. Если опция шаблона совпадает со встроенной, то передать в шаблон опцию можно после --."

  4. 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: Описание типа 1.
    2. Тип 2: Описание типа 2.
    3. Тип 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. Однако, шаблоны могут поддерживать свои опции.

    Примечание

    При указании целевой директории шаблонные опции необходимо писать строго после неё. Если опция шаблона совпадает со встроенной, то передать в шаблон опцию можно после --.

    Примеры использования

    1. Создание проекта типа example-type в текущем каталоге:

      bob project create example-type
      
    2. Создание проекта типа example-type в указанном каталоге ./my_project:

      bob project create example-type ./my_project
      
    3. Создание проекта по шаблону py_program в каталоге ./my_python_project и указанием опции author:

      bob project create py_program ./my_python_project --author "John Doe"
      
    4. Получение полного списка доступных типов проектов (включая шаблонные):

      bob project create --help
      

    Заключение

    Команда bob project create является мощным инструментом для создания новых проектов с заданными параметрами и типами. Используйте bob project create --help для получения дополнительной информации и полного списка доступных типов проектов и опций.

  5. User

    Перефразируй "Шаблон проекта — это, по сути, две опциональных функции на Python 2 и набор опять же опциональных jinja-шаблонов. Шаблон должен быть размещён в поддиректории в devtools/bob/handlers/project/templates и зарегистрирован в devtools/bob/handlers/project/templates/templates.yaml

    Создать заготовку для шаблона проекта можно командой bob project create project_template, которая сама является примером шаблонной генерации."

  6. Assistant

    Шаблон проекта представляет собой две необязательные функции на Python 2 и набор необязательных jinja-шаблонов. Шаблон должен находиться в поддиректории devtools/bob/handlers/project/templates и быть зарегистрирован в файле devtools/bob/handlers/project/templates/templates.yaml.

    Создать основу для шаблона проекта можно с помощью команды bob project create project_template, которая сама является примером использования шаблонной генерации.

  7. User

    Добавь к документации пункт "##### Готовим параметры

    В функции get_params нужно получить данные, необходимые для создания шаблона проекта и сформировать словарик env, который будет использоваться для подстановки в jinja-шаблоны и передан в prostprocess. Параметры можно получить из переданного контекста (параметр context), разбором опций, переданных в контексте или интерактивным запросом у пользователя.

    Параметр context — это namedtyple типа Context из template_tools.common. В нём доступно 5 свойств:

    • path - относительный путь от корня репозитория до создаваемого проекта
    • root - абсолютный путь корня репозитория
    • owner - значение, переданное параметром --set-owner
    • args - список неразобранных аргументов, переданных в конце вызова bob project create <project_name> [path] [args]
    • backup - объект из template_tools.common, позволяющий сохранять оригинальные файлы перед их редактированием. Файлы будут восстановленый в случае исключений во время геренерации проекта, а также будут сохранены в ~/.bob/tmp на случай если что-то пойдёт не так (сохраняются файлы от последних 5 сейссий).

    Код для get_params может выглядеть, например так:". Напиши только этот пункт

  8. Assistant

    Готовим параметры

    В функции get_params нужно получить данные, необходимые для создания шаблона проекта и сформировать словарик env, который будет использоваться для подстановки в jinja-шаблоны и передан в prostprocess. Параметры можно получить из переданного контекста (параметр context), разбором опций, переданных в контексте или интерактивным запросом у пользователя.

    Параметр context — это namedtuple типа Context из template_tools.common. В нём доступно 5 свойств:

    • path — относительный путь от корня репозитория до создаваемого проекта
    • root — абсолютный путь корня репозитория
    • owner — значение, переданное параметром --set-owner
    • args — список неразобранных аргументов, переданных в конце вызова 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
    

    Этот код получает базовые параметры из контекста, добавляет дополнительные параметры из аргументов и делает интерактивные запросы у пользователя, чтобы собрать все необходимые данные для создания шаблона проекта.

  9. 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 без явного указания типа проекта."

  10. 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 можно будет запускать без явного указания типа проекта.

  11. User

    перефразируй "После генерации будет вызвана функция postprocess. В ней можно внести финальные штрихи в сегенрированный проект или вывести сообщение. В частности, с помощью вызова add_recurse(context) из template_tools.common можно добавить наш проект в родительской директории."

  12. Assistant

    После генерации проекта будет вызвана функция postprocess. В этой функции можно выполнить окончательные доработки, внести изменения или вывести сообщения. Например, с помощью вызова add_recurse(context) из модуля template_tools.common можно добавить новый проект в родительскую директорию.

  13. User

    "Теперь можно проверить наш шаблон. Он будет взят во время запуска команды ya project create, ничего пересобирать не требуется. "

  14. Assistant

    Теперь можно протестировать наш шаблон. Он будет автоматически использован при запуске команды ya project create, никаких дополнительных сборок не потребуется.

  15. User

    "#### Об именовании файлов в шаблонне

    Обычно файлы в шаблоне переносятся в генерированный проект под своими именами. Однако есть несколько дополнительных правил, призванных помочь обойти странные и сложные случаи.

    • Файл .empty.notemplate позоляет создать пустую директорию. Все файлы в директории, содержащие такой файл, будут проигнорированы.

    • Файлы с расширением .notemplate игнорируются. Это позволяет иметь в директории шаблона служебные файлы, которые не будут считаться шаблонами и попадать в проект.

    • Файлы с расширением .template после подстановки шаблонов записываются в проект без расширения .template. Это позволяет иметь в шаблоне файлы, которые могут по своим обычным именам специально обрабатываться. Например, a.yaml иметь в шаблоне нельзя, но можно положить a.yaml.template и в целевом проекте после подставновки шаблона он станет a.yaml.

    • Чтобы добавить в проект файл x.template, положите для него шаблон x.template.template
    • Чтобы добавить в проект файл x.notemplate, положите для него шаблон x.notemplate.template"
  16. Assistant

    Об именовании файлов в шаблоне

    Обычно файлы из шаблона переносятся в генерируемый проект с сохранением своих имен. Однако есть несколько дополнительных правил, призванных помочь обойти сложные и необычные случаи.

    • Файл .empty.notemplate позволяет создать пустую директорию. Все файлы в директории, содержащей такой файл, будут проигнорированы.

    • Файлы с расширением .notemplate игнорируются. Это позволяет иметь в директории шаблона служебные файлы, которые не будут считаться шаблонами и не попадут в проект.

    • Файлы с расширением .template после подстановки данных шаблона записываются в проект без расширения .template. Это позволяет иметь в шаблоне файлы, которые могут быть специально обработаны под своими обычными именами. Например, в шаблоне нельзя иметь файл a.yaml, но можно использовать a.yaml.template, и после подстановки данных он станет a.yaml в целевом проекте.

    Примеры:

    • Чтобы добавить в проект файл x.template, положите для него шаблон с именем x.template.template.
    • Чтобы добавить в проект файл x.notemplate, положите для него шаблон с именем x.notemplate.template.