Նախորդ հոդվածում, , մենք ուսումնասիրել ենք, թե ինչպես կառուցել CLI գործիքը բջջից հետո: Այժմ, խնդրում ենք վերցնել հաջորդ քայլը — ինչպե՞ս կարող եք այն լավ անել: Հիմնականում, սեղմվում է օգտագործման հեշտությամբ: Լավ դիզայնված CLI- ը զգում է, որ օգտագործողը զգում է ինտեգրտական, հարմարավետ եւ արդյունավետ: Սակայն, այս օգտագործման հեշտությունը հասանելի է մի քանի տարբեր դիզայնային պայմանների միջոցով, որոնք մենք ուսումնասիրենք այս հոդվածում: Հիմնական հոդված՝ Master the Art of Command Line: Your Ultimate Guide to Developing Powerful Tools Հիմնական հոդված՝ Master the Art of Command Line: Your Ultimate Guide to Developing Powerful Tools Ցուցադրման համար, մենք օգտագործենք , բայց սերտիֆիկները կիրառվում են ամեն CLI սերտիֆիկին, որը դուք կարող եք օգտագործել: Click Python library Parameters-ի մասին Շատ CLI գործիքները ընդունում են օգտվողի մանրամասներ: Այս մանրամասները ամենահասակով չեն ինտերնետային, դա մանրամասների ձեւով է: Դա նշանակում է, թե ինչպես է գործիքը աշխատում. parameters Օրինակ, The Կարդացեք, թե ինչ է այն, ինչ պետք է պետք է պետք է ստանալ այն, ինչ պետք է պետք է պետք է: cp 
 
 
 Ֆիլմը կամ ֆայլը, որը պետք է բեռնել, եւ Տղամարդկանց ուղեցույց. Այն կարող է նաեւ ստանալ տարբերակներ, ինչպիսիք են Ինչպե՞ս կարող է անգլերեն արտադրել. -v Բարձրապես, կա երկու տեսակի parametrs:  and  Մինչեւ CLI- ում, անհրաժեշտ պարամետրերը կոչվում են (Տեսանյութ) Արդյոք, թե ինչու է անում, թե ինչու է անում . required optional arguments options Հիմնական аргументи Որպես անունը ցույց է տալիս, Օգտագործողը ապահովում է արժեքները որոշակի կարգով, եւ գործիքը նշանակում է նրանց այնպես: positional arguments Օրինակ, եթե Հիմնական հոդվածը Հիմնական հոդվածը Հիմնական հոդվածը Հիմնական հոդվածը Հիմնական հոդվածը Հիմնական հոդվածը եւ — Օգտագործողը կունենա այն որպես: cp Հիմնական destination cp source destination
 Մինչեւ ձեր գործիքը պահանջում է տպագրություն, այն հաճախ կախված է (լուսանկարներ) պետք է օգտագործողներին մանրամասով որոշել յուրաքանչյուր արժեքը: . if you can provide a sensible default, make it an option instead of an argument Օրինակ, a Parameter- ը կարող է փոխվել Բարձրացնել օգտվողներին, որ մոռանում են տեղը եւ միշտ մոռանում են տեղեկատվություն, չի ավելացնել արժեքը - դա պարզապես ավելացնում է թռիչքը: --log-level info Շատ հարցեր Երբեմն մի գործիք կարող է պետք է ստանալ Հիմնական օրինակ, մի շարք ֆայլեր, որոնք կարող են բեռնել մի շարք ֆայլեր, որոնք կարող են բեռնել մի շարք ֆայլեր, որոնք կարող են բեռնել մի շարք ֆայլեր: multiple values cp source1 source2 destination
 Կան մի քանի սխալներ — սովորաբար, Դուք կարող եք ստանալ մի քանի արժեքներ: Ձեր կոդըը (լուսանկարներ) պետք է աշխատել լրացուցիչ հավելվածության եւ ռեժիմի հետ: only one argument Options Օգտագործողները կարող են նշել պարամետրերը անունով, սովորաբար ձեւով: Եթե օգտագործողը չի ապահովում տարբերակ, գործիքը օգտագործում է իր ստանդարտ արժեքը: Options --option value Օրինակ՝ --log-level debug
 Հիմնական տարբերակը, որը կարող է լինել, այն է, որ թռչունը ոչ մի արժեք է: Պարզապես, թռչունը, որը կարող է լինել, կարող է փոխվել, ինչպիսիք են սխալային արտադրանք: --verbose
 Հիմնական անունները պետք է , այնպես որ օգտագործողները կարող են հեշտությամբ հասկանալ իրենց նպատակը: clear and descriptive Ապրանքի օրինակներ : @click.command()
@click.option('--verbose', is_flag=True)
@click.option('--log-level', default="info")
@click.argument('srcs', nargs=-1)
@click.argument('dst')
def copy(verbose: bool, log_level: str, srcs: tuple[str, ...], dst: str):
   ...
 Այժմ գործիքը կարող է կոչվել մի քանի ձեւով: cp --verbose --log-level trace source1 source2 destination
cp source destination
 Short տարբերակներ Այսպիսով, մենք օգտագործում ենք երկար տարբերակների անուններ: Նրանք հարմար են սերտիֆիկների համար, քանի որ նրանք հուսալի են եւ հեշտ են հասկանալ մի տեսանյութում: Սակայն, արագ, մեկ անգամ ուղեցույցների համար, հաճախ օգտագործողները սիրում են Քանի՞ Մինչեւ Եթե ձեր գործիքը ունի բազմաթիվ տարբերակներ, դուք կարող եք արագ տեւել ինտեգրտական գրքեր - հատկապես քանի որ բազմաթիվ տարբերակներ կարող են սկսել միասին. . short options -v --verbose frequently used options Example: @click.command()
@click.option('-v', '--verbose', is_flag=True)
@click.option('--log-level', default="info")
@click.argument('srcs', nargs=-1)
@click.argument('dst')
def copy(verbose: bool, log_level: str, srcs: tuple[str, ...], dst: str):
   ...
 Այժմ երկու ձեւերը աշխատում են: cp -v source destination
cp --verbose source destination
 Օգտագործողի մատակարարումը եւ սխալը արագ Հեղինակային գործիքը պետք է Արդյոք, թե ինչ է այն, թե ինչ է այն, թե ինչ է այն, թե ինչ է այն, թե ինչ է այն, թե ինչ է այն, թե ինչ է այն, թե ինչ է այն. validate user input early Օրինակ, Click- ը կարող է ավտոմատորեն հաստատել valid log levels եւ path arguments: @click.command()
@click.option('-v', '--verbose', is_flag=True)
@click.option('--log-level', default="info", type=click.Choice(["debug", "info", "error"]))
@click.argument('srcs', nargs=-1, type=click.Path())
@click.argument('dst', type=click.Path())
def copy(verbose: bool, log_level: str, srcs: tuple[str, ...], dst: str):
   ...
 Այնուամենայնիվ, դուք կարող եք պետք է Ի մեր Նշում է: custom logic copy 
 
 
 Եթե մեկն է, ապա նպատակը կարող է լինել ֆայլը կամ ֆայլը: Եթե ունեք մի քանի սերտիֆիկներ, նպատակը պետք է լինի մի թերթիկ, այլեւս ֆայլերը կարող են անմիջապես վերլուծվել: Generic CLI գրասենյակները չի աշխատում այդպիսի գործիքները ավտոմատորեն, այնպես որ այս ստուգման պետք է ապրում ձեր կոդը. օգնություն հաղորդագրություն Լավ գործիքը միշտ ապահովում է լավ . help message Users should be able to run something like  Դա տեսնում է: --help 
 
 
 
 Ո՞վ են հասանելի պարամետրերը Նրանք նշանակում են Արդյոք, դուք կարող եք ստանալ, թե ինչպես պետք է ստանալ, թե ինչպես պետք է ստանալ, թե ինչպես պետք է ստանալ: Պահպանեք ժամանակը, կտրեք սխալները եւ բարելավեք օգտվողների հավասարությունը ձեր գործիքում: Տեղադրեք ձեր ecosystem մոդելները Լավագույն CLI գործիքները զգում են Ուսանել այլ գործիքներ ձեր տարածքում եւ հետեւել իրենց պայմանները - հատկապես . native naming options and arguments Unix աշխարհում, ինչպիսիք են Հիմա եւ Բոլոր օգտագործումներ եւ Հիմնական հարցեր, ինչպես նաեւ Երբեք առաջանում . cp mv rsync source destination source destination Հիմնական հոդված՝ Հիմնական հոդված՝ Հիմնական հոդված՝ Հիմնական հոդված ( Աղջիկի համար, Պահպանելու համար, Երկու տեւողությունը, Արդյոք, ձեր գործիքը անջատորեն ներառում է օգտվողի աշխատանքային արագությամբ: -v -r -n -h/--help Երբ ձեր գործիքը զգում է, որ այն էլեկտրոնային համակարգի բնական մաս է, օգտագործողները շատ ավելի հեշտ են օգտագործել այն եւ սիրում են օգտագործել այն: Արդյոք այլ Aspects Ավելի քան մի քանի տարբերակներ եւ տարբերակներ, ինչպիսիք են տարբերակները CLI գործիքը պարզապես գործառույթային է: Նրանք ազդում են այն, թե ինչպես ձեր գործիքը ինտեգրում է scripts- ի հետ, թե ինչպես օգտագործողները debug խնդիրները, եւ թե ինչպես հեշտությամբ այն հարմարվում է ավելի մեծ գործառույթների մեջ: Լավ Exit կոդը Բոլոր ծրագրերը վերցնում են Այս կոդը թույլ է տալիս զանգահարողը գիտել, թե՞ ծրագրը հաջողվել է կամ չգիտել է: exit code Հիմնական Konventionen: 
 
 
 0 նշանակում է հաջողություն Ոչ գունավոր արժեքը նշում է սխալը Չնայած, որ արտադրանքի կոդը համար ոչ մի համաշխարհային ստանդարտ է, այն լավ գործիք է, որ . exit with a non-zero code on any error Բարձր ճշգրիտության համար, փնտրեք, թե ինչպես են հետեւվում համոզվածություններները Նրանք հայտնի են Unix- ի աշխարհում: Բարձրագույն Bash-Scripting Guide Դուք պետք է նաեւ Նրանք ներառում են The Երբ օգտագործողները կամ ավտոմատացման համակարգները գիտեն, թե ինչ է նշանակում արտադրանքի կոդը 3, նրանք կարող են ավելի հզորորեն աշխատել սխալների հետ (հարկե, վերցնել, փոխել, կամ վկայագրել). document your exit codes --help STDOUT vs STDERR- ը CLI գործիքը տարբերում է իր երկու ստանդարտ արտադրանքի ցանցերի միջեւ: 
 
 
 STDOUT-ի համար ստանդարտ, նախընտրված արտադրանքի համար STDERR — սխալների, երաշխիքների կամ դիզայնային հաղորդագրությունների համար Այս տարբերությունը թույլ է տալիս օգտվողներին եւ սեղմիչները յուրաքանչյուր սեղմիչը անմիջապես աշխատելու համար: Օրինակ, օգտվողը կարող է վերլուծել սովորական արտադրանքի ֆայլը, իսկ սխալ հաղորդագրությունները կարող են տեսնել կոճակը: mytool > output.txt
 or suppress errors: mytool 2>/dev/null
 Եթե ձեր գործիքը գրում է այնպես էլ տվյալները եւ սխալները STDOUT- ում, օգտագործողների պետք է մանրաձայնորեն փաթեթավորել արտադրանքը, եւ դա պակաս է: Especially if your tool’s output is consumed by other programs, keeping STDOUT clean and predictable is essential. Ապրանքի ձեւաչափ Եթե ձեր գործիքը արտադրում է տվյալներ, որոնք կարող են օգտագործվել այլ գործիքների կամ scripts- ի կողմից, այն հեշտ է աջակցել formats, ինչպիսիք են JSON կամ YAML. machine-readable output Օրինակ՝ mytool --output json
 Այսպիսով ավտոմատացման շատ ավելի հեշտ է: այլ գործիքները կարող են օգտագործել ստանդարտ փոստիչներ, այլեւ օգտագործել սխալ գծի փոստիչներ, որոնք կտրում են ամեն անգամ, երբ թռիչքները, հարմարեցումը կամ փոստիչները փոխվում են: Միայն, ոչ ոք չգիտեք, թե ինչ է անում ձեր գործիքը, քանի որ շատ օգտվողները նույնիսկ անում են ձեր գործիքը ինտերնետային ձեւով: 
 
 
 Պահպանված է հարդալելի արտադրանքը (nicely formatted text) Խնդրում ենք առաջարկել մի թռիչք (մպ. --json կամ --format, եթե դուք ցանկանում եք աջակցել բազմաթիվ ձեւաչափեր) strukturated արտադրանքի համար CLI գործիքները նաեւ ապահովում են , տպագրման ժամանակ տպագրման ժամանակ տպագրման ժամանակ տպագրման ժամանակ տպագրման ժամանակ տպագրման ժամանակ տպագրման ժամանակ JSON- ը, երբ տպագրվում է այլ գործընթացում:  or  Կարդալ auto-detection kubectl gh սխալ հաղորդագրություններ Լավ սխալ հաղորդագրություն պետք է լինի: 
 
 
 
 Clear - նշեք, թե ինչ էր սխալ Օգտագործելի — suggest how to fix it Համատեղելի - օգտագործեք նույն գծի եւ կառուցվածքի ամբողջ ժամանակը Լավ օրինակ է: Error: failed
 Լավագույն օրինակ: Error: Could not open file '/tmp/input.txt' — file not found.
Hint: Verify that the path is correct and you have read permissions.
 Good error handling saves users time and helps them build trust in your tool. Տեղադրություն եւ Verbosity Օգտագործողները սիրում են վերահսկել, թե ինչպես շատ տեղեկատվություն տեսնում են: 
 
 
 
 Հիմնական հոդված՝ Minimal Output --verbose համար մասնագիտացված հաղորդագրություններ --Debug համար Developer- ի մակարդակի tracing Դիզայնել ձեր logging մակարդակները, որպեսզի օգտվողները կարող են ընտրել ճիշտ չափը տեղեկատվություն իրենց միջավայրի համար. Երբ համատեղելի են ճիշտ արտադրանքի կոդըների հետ, այդ մակարդակները շատ ավելի հեշտ են վերահսկել եւ ավտոմատել: Responsiveness եւ կատարումը Եթե ձեր CLI-ը կատարում է խոշոր գործառույթներ, խնդրում ենք ապահովել կամ Օրինակ՝ progress indicators spinners Downloading files... 45% complete
 Միեւնույն ժամանակ, փնտրեք անսահմանափակ animations կամ արտադրանքը, երբ գործիքը կատարվում է անսահմանափակ մեթոդում (հարկե, որպես մասը script). Հյուրատետր CLI գործիքը ստեղծելու համար հեշտ է: Կարդալ 1 - դա իրական գործառույթ է: Լավ փոստի գծի գործիքը զգում է բնականին, գործառույթը նախընտրելի է, եւ փրկվում է օգտագործողի աշխատանքային արագության մեջ: Այն չի խուսափում օգտագործողներին, որ հարմարվում են  — it adapts to how users already work. good Դա Այս հոդվածում, մենք տեսել ենք, թե ինչը օգնում է այդ փորձը: 
 
 
 
 
 
 
 Պիտակ եւ համատեղելի պարամետրեր, որոնք համատեղում են հեշտությունը եւ լայնությունը Հիմնական կոդը, որը հաղորդում է հաջողությունը կամ սխալը STDOUT- ի եւ STDERR- ի ճշգրիտ օգտագործումը տվյալների վտանգավորելու համար  formats for both humans and machines Readable and structured output Օգտագործելի սխալ հաղորդագրություններ եւ նախընտրելի գործառույթներ Տեղադրեք ձեր էլեկտրոնային համակարգի պայմանները, այնպես որ ձեր գործիքը զգում է առաջին անգամ Իհարկե, լավագույն CLI գործիքները համատեղում են մի համատեղ: նրանք Նրանք արագ սկսում են, արագ սխալում են, բացահայտել են իրենց մասին, եւ հեշտությամբ ներգրավվում են ավելի մեծ համակարգերի եւ գրասենյակների մեջ: respect the user’s time Եթե դուք մոռանում եք այդ պայմանները, ինչպիսիք են համոզվածություն, համոզվածություն եւ համոզվածություն ձեր օգտագործողների համար, ձեր CLI գործիքը չի պարզապես ; it’ll be a pleasure to use. Աշխատանք

Walkthroughs, tutorials, guides, and tips. This story will teach you how to do something new or how to do something better.

Read My Stories

Այս աուդիոն պատրաստվել է պատմության բնօրինակ լեզվով:

Ինչպես նախագծել CLI գործիք, որը մշակողները իրականում սիրում են օգտագործել

About Author

ՄԵԿՆԱԲԱՆՈՒԹՅՈՒՆՆԵՐ

ԿԱԽՎԵԼ ՏԵԳՍԵՐ

ԱՅՍ ՀՈԴՎԱԾԸ ՆԵՐԿԱՅԱՑՎԵԼ Է Մ

Related Stories

HyperCycle Announces Strategic Split into Two Distinct Operations

HyveDA Secures $50 Million in Pre-Deposits After Symbiotic Mainnet Launch

Hypernative Bolsters Bitcoin L2 Security as Stacks Ecosystem Gets Real-Time Protection

Toufi Saliba: The Architect Behind HyperCycle's Decentralized Network of AI

HyperCycle Announces Strategic Split into Two Distinct Operations

HyveDA Secures $50 Million in Pre-Deposits After Symbiotic Mainnet Launch

Hypernative Bolsters Bitcoin L2 Security as Stacks Ecosystem Gets Real-Time Protection

Toufi Saliba: The Architect Behind HyperCycle's Decentralized Network of AI

Light-Mode

Classic

Newspaper

Dark-Mode

Neon Noir

Minty

HN StartUps