Форматирование текста в markdown согласно шаблону

Да, реально. Делай. Да, можно на Питоне, хотя если заморочиться, то можно даже и на sed. Для Питона смотри методы .split() и .format().

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

«С утра тоже покурить? Милалыч явой угощает» (c)
https://sed-docs.github.io/html/

«Космосом» же!

А по теме меня мало прельщает перспектива городить все это на sed'е :-D

Я вот час примерно гуглил регулярку, чтобы матчила нужную мне подстроку до второго пробела, чтобы вырезать опции. Т.е. чтобы из этого

v-add-backup-host
Usage: v-add-backup-host TYPE HOST USERNAME PASSWORD [PATH] [PORT]

Получить только аргументы, которые прописными буквами. Получилось что-то вроде

(Usage:.*?\s.*?\s)

А народ мне предлагает седом не только резать но и форматировать... не я понимаю, что на нем и шахматы писали... но все равно как-то не по себе)))

«Космосом» же!

Нет «явой»!
upd Хотя нагуглил вариант с «Космосом», видимо есть и такое.

А народ мне предлагает седом не только резать но и форматировать...

Не предлагает, вы сами спросили «Ради интереса дай кусок портянки на sed». Вопрос: Можно ли на sed написать? Ответ: Да. Но вот надоли? если его не знаете? :)

ЗЫ

не я понимаю, что на нем и шахматы писали...

Не только шахматы. Из моих «закладок», получено от одного из лоровцев (емнип его там Flappy Bird)
https://www.youtube.com/playlist?list=PLdvB7n7RN2UCVb7GnKQu_R-fbQ-laLtkZ

Решил задачу кучей регулярок в Notepad++

Вот же ж я офтопичное чудовище :-D

WitcherGeralt, а как бы ты по быстрому решил вопрос, используя предложенные выше .split() и .format()?

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

Но, если очень хочется сплиты, то так:

def f(txt): 
     b = [] 
     for cmd in txt.split('\n\n'): 
         cmd, args = cmd.split('\n', 1) 
         args = args.split(None, 2)[2] 
         b.append(f'**{cmd}**\n\n<TODO: add description>\n\n**OPTIONS**\n\n\t{args}') 
     return '\n\n\n'.join(b)

Ты, если я правильно понял, решил использовать замену?

Да. Да и вообще, сегодня показал главному разрабу нынешнее форматирование (это была для него новость, но ничего), он хочет, чтобы все это дело форматировалось по-другому. Пока условный тимлид в отпуске буду менять подход.

Может твой сниппет сгодится, спасибо.

Как и чем его преобразовать в формат Markdown такого вида?

Если всё так просто, то просто

text = '''v-acknowledge-user-notification
Usage: v-acknowledge-user-notification USER NOTIFICATION

v-add-backup-host
Usage: v-add-backup-host TYPE HOST USERNAME PASSWORD [PATH] [PORT]'''


md = '\n'.join(map(
    lambda x: 'Usage:' in x and x.replace('Usage: ', '**Usage:**\n\n    ') or \
              not x and f'\n' or f'**{x}**\n',
    text.split('\n')))
print(md)

**v-acknowledge-user-notification**

**Usage:**

    v-acknowledge-user-notification USER NOTIFICATION


**v-add-backup-host**

**Usage:**

    v-add-backup-host TYPE HOST USERNAME PASSWORD [PATH] [PORT]

P.S. Код ни на что не претендует, просто пользуюсь «реальными» задачками с ЛОРа для тренировок в функциональщину в питоне.

Не то, что требовалось в ОП посте (да и сегодня решили сменить форматирование, см выше), от функциональщины в глазах зарябило. Выхлоп должен быть вида

**v-rebuild-mail-domains**
 
The function rebuilds EXIM configuration files for all mail domains.



**OPTIONS**

    user

Тем не менее спасибо за участие.

P.S. Описание в выхлоп добавлять не обязательно.

args.split(None, 2)[2]

Это второй элемент списка аргументов, далее делим эту строку на 2 части?

Так?

Да. Но лучше делать:

arg1_nice_name, arg2_nice_name, arg3_nice_name, foo, bar = args.split(None, 5)

Делим строку по любому whitespace дважды (т.е. на три части), берём второй по индексу (т.е. третий) элемент.

In [1]: str.split?                                                                                    
Docstring:
S.split(sep=None, maxsplit=-1) -> list of strings

Return a list of the words in S, using sep as the
delimiter string.  If maxsplit is given, at most maxsplit
splits are done. If sep is not specified or is None, any
whitespace string is a separator and empty strings are
removed from the result.
Type:      method_descriptor

Советую тебе iPython, очень удобно для отладки маленьких кусочков кода. Вообще, в REPL-режиме интерпретатора тоже можно и help, и dir, __doc__ попринтить, но в iPython это удобней.

Число аргументов произвольное же.

ОК.

Подскажи пожалуйста, какой регуляркой сматчить

V-Add-Letsencrypt-Domain User

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

Зато нашел регулярку, которая матчит прописные буквы вне скобок

[A-Z]+(?![^\[\]]*\])

В общем и целом, я продолжаю извращаться...

Хотя пока оформил вот так,

(V-..*?\s)

Не подскажешь как решить такую подзадачу https://superuser.com/questions/1433308/surround-certain-string-with-specifie...

Кажись, что тут посложнее, чем в ОП. Тоже можно Питоном.

Возврат к sed ? :)

sed -r 's/^(v-.*)$/*********\n\1\n*********/' 

Переносы строк забыл ты :-)

Но, что sed'ом, что скриптом на Питоне, нам все равно нужна регулярка.

Суть ясна. Благодарю за оперативность.

Спасибо.

Кстати, а как тут сделать inplace редактирование?

Ключ -i просто так не заводится :-)

А, понял для седа порядок аргументов некоммутативен :-D

ir != ri