Mənim əvvəlki yazıma görə, İndi, bir CLI alətini qurmaq üçün necə hazırlayırıq.Sonra, bir sonraki adımı edəcəyik – necə yaxşılaşdırırsınız? Son olaraq, anahtar istifadə asanlığındadır. Yaxşı dizayn edilmiş bir CLI istifadəçi üçün intuitiv, öngörülə bilər və effektiv hiss edir. Komandanın sənəti: Güclü alətlər yaratmaq üçün Ultimate Guide Komandanın sənəti: Güclü alətlər yaratmaq üçün Ultimate Guide Demonstrasiya üçün biz bu , lakin prinsiplər sizin istifadə etdiyiniz hər bir CLI çerçevəyə uygulanır. Click Python library Parametrlər VVD - Hollandiyada futbolçu bu adla tanımır, orada VVD daha çox mərkəz-sağı təmsilən edən siyasi partiyanın adının qısaltması kimi bilinir - artıq sorğu-suala ehtiyacı olmayan ulduzdu. Bu, instrumentun necə işlədiyini göstərir. parameters Misal olaraq, o Komandanın ən azı iki parametrə ehtiyacı var: cp 
 
 
 “Qəbələ”ni və ya “Qəbələ”ni izləyib. Destinasiyaya gələrək yol. Buna görə də belə parametrlər qəbul olunmalıdır. Bu, verbal işləməyə imkan verir. -v Birincisi, iki tip parametr var: və Çoğu CLI kütüphərində, istənilən parametrlər (VVD - Hollandiyada futbolçu bu adla tanımır) . required optional arguments options Pozitif argumentlər Adının deyildiyi kimi, VVD - Hollandiyada futbolçu bu adla tanımır, orada VVD daha çox mərkəz-sağı təmsilən edən siyasi partiyanın adının qısaltması kimi bilinir - artıq sorğu-suala ehtiyacı olmayan ulduzdu. positional arguments Misal olaraq, əgər Əsas səhifə » Əsas səhifə » Əsas səhifə və - istifadəçi bunu belə adlandırır: cp Kaynak Destinasiyası cp source destination
 VVD - Hollandiyada futbolçu bu adla tanımır, orada VVD daha çox mərkəz-sağı təmsilən edən siyasi partiyanın adının qısaltması kimi bilinir - artıq sorğu-suala ehtiyacı olmayan ulduzdu. . if you can provide a sensible default, make it an option instead of an argument Misal olaraq, a Parametrlər dəyişə bilər Kullanıcılara pozisyonu xatırlamaq və hər zaman xəbər vermək qiymət artırmaz - yalnız sürünürlük artırır. --log-level info Bir çox argumentlar Bir zamanlar bir instrument qəbul etmək lazımdır. Bir neçə ildir ki, bir neçə ildir ki, bir neçə ildir ki, bir neçə ildir ki, bir neçə ildir ki, bir neçə ildir ki, bir neçə ildir ki, bir neçə ildir ki, bir ildir ki, bir ildir ki, bir ildir ki, bir ildir ki, bir ildir ki, bir ildir ki, bir ildir ki, bir ildir ki, bir ildir ki, bir ildir ki, bir ildir ki, bir ildir ki, bir ildir ki, bir ildir ki, bir ildir ki, bir ildir ki, bir ildir ki, bir ildir ki, bir ildir. multiple values cp source1 source2 destination
 Bəzən bir şey var ki, tipik Sizin kodunuz (argument analiziçi deyil) daha çox validasiya və logik işləməlidir. only one argument Seçkilər “Neftçi”nin “Türkçüləri”nin “Türkçüləri”nin “Türkçüləri”nin “Türkçüləri”nin “Türkçüləri”nin “Türkçüləri”ni VVD - Hollandiyada futbolçu bu adla tanımır, orada VVD daha çox mərkəz-sağı təmsilən edən siyasi partiyanın adının qısaltması kimi bilinir - artıq sorğu-suala ehtiyacı olmayan ulduzdu Options --option value Misal olaraq: --log-level debug
 VVD - Hollandiyada futbolçu bu adla tanımır, orada VVD daha çox mərkəz-sağı təmsilən edən siyasi partiyanın adının qısaltması kimi bilinir - artıq sorğu-suala ehtiyacı olmayan ulduzdu. --verbose
 Adları seçmək lazımdır Beləliklə, istifadəçilərin işini asanlaşdırmaq mümkün olur. clear and descriptive Uygulama məsələləri: @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):
   ...
 Artıq bu alət bir neçə şəkildə çağırılabilir: cp --verbose --log-level trace source1 source2 destination
cp source destination
 Kısa seçki Bugüne qədər, uzun seçki adları istifadə etmişik.Bu, skriptlər üçün idealdır, çünki onlar özlərini izah edir və bir gözlə anlayır. Bununla yanaşı, çox vaxt istifadəçiləri bir-birini tercih edir. Bəzən Yerindən Xatırladaq ki, hər bir variantın bir seçkiya ehtiyacı yoxdur.Əgər cihazınızda bir çox seçkiya ehtiyacı varsa, çoxlu seçkiya yalnız bir versiyadan başlayacağına baxmayaraq, çoxlu seçki yalnız bir versiyadan başlayır. . short options -v --verbose frequently used options Şəkil : @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):
   ...
 Artıq hər iki formalar işləyir: cp -v source destination
cp --verbose source destination
 Kullanıcının girişini validə edin və sürətləndirin Qiymətli bir qida aparıcısı olmalıdır Xatırladaq ki, çoxsaylı problemlər yaranıb, çoxsaylı problemlər yaranıb. validate user input early Təkcə, Click valid log levels və path argümanlarını otomatik olaraq qüvvətləndirə bilər: @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):
   ...
 Buna görə də sizə ehtiyac var Bizim içimizdə Əksinə: custom logic copy 
 
 
 Bir resurs varsa, destinasiyası bir dosya və ya direktoriyadır. Bir çox kaynaklar varsa, hədəf bir direktoriyadır – yoxsa faillar bir-birini gözləməkdən ötrü yazabilir. Generic CLI kütüphərləri bu məsələləri otomatik olaraq işləmir, bu nedenle bu validasiya kodunuzda yaşaymalıdır. Yardım mesajı Hər zaman yaxşı bir alət verir. . help message Kullanıcılar belə bir şey edə bilərlər. Görmək üçün: --help 
 
 
 
 Nə parametrlər var Onların anlamı Accepted types or values (e.g., valid log levels) Təsadüfi yardım mesajı vaxtı xərcləyir, hataları azaldır və alətinizdəki istifadəçi güvenini artırır. Ekosistemlərinizə baxın Son olaraq, böyük CLI alətləri hiss edir Ötən il Bakıya getmək istəyənlərin sayı artıb - VİDEO . native naming options and arguments UNIX dünyasında belə bir şey var: və və Bütün istifadə və Argumentlər kimi, Hər zaman öncə . cp mv rsync source destination source destination Əsas səhifə / Siyasət / Siyasət / Siyasət ( Bu sözlə,  for recursive,  Qısa sürüş üçün, İşçilərinizin iş təcrübəsi ilə bağlı problemlər də həll olunmalıdır. -v -r -n -h/--help Tooliniz ekosistemin doğal bir parçası kimi hiss edildikdə, istifadəçilər onu qəbul etmək və onu istifadə etməkdən daha çox sevirlər. Başqa aspektlər Parametrlərin və argumentlərin yanı sıra, bir çox digər faktorlar var ki, bir Bu aspektlər alətinizin skriptlərlə necə bütünlüklə işlədiyini, istifadəçilərin problemləri necə düzəltdiyini və daha böyük iş aksiyalarına nə qədər asanlıqla daxil olacağını etkiləyir. Yaxşı Çıxış kodları Hər bir programı qaytarır Bu kod, çağırıcıya programın uğurlu olduğunu və ya başarısız olduğunu bildirir. exit code Konvensiya ilə bağlı: 
 
 
 0 - Başarı 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 Xatırladaq ki, bu standartlar heç bir standart deyil, lakin ən azından . exit with a non-zero code on any error Daha yaxşı işləyə bilərik ki, Konvensiya Bunlar Unix dünyasında çox tanınmışdır. Advanced Bash-Scripting Guide Siz də olmalıdır Onları içərisində Tədbirdə iştirak edən və ya iştirak edən hər kəs üçün “Qəbələ 3” və “Qəbələ 3” ilə bağlı məlumatlar təqdim olunacaq. document your exit codes --help Stardust və Stardust Yaxşı davranışlı bir CLI alətinin iki standart çıxışı arasında fərqlənir: 
 
 
 STDOUT — normal, gözləməli çıxış üçün STDERR – hatalar, xəbərdarlıqlar və ya diagnostik mesajlar üçün VVD - Hollandiyada futbolçu bu adla tanımır, orada VVD daha çox mərkəz-sağı təmsilən edən siyasi partiyanın adının qısaltması kimi bilinir - artıq sorğu-suala ehtiyacı olmayan ulduzdu. mytool > output.txt
 Yanlışlıqları düzəltmək: mytool 2>/dev/null
 Əgər alətiniz STDOUT-a həm verilər, həm də hatalar yazırsa, istifadəçilərə outputları manuel olaraq filtr etmək lazımdır – və bu pisdir. Əsas olaraq, əgər alətinizin çıxışı digər programlar tərəfindən istifadə edilirsə, STDOUT-u təmiz və öngörülə saxlamaq çox vacibdir. Formata daxil olmaq Əgər alətiniz digər alətlər və ya skriptlər tərəfindən istifadə edilə biləcəyini göstərən məlumatlar verirsə, buna kömək etmək yaxşıdır. Bu formatlar JSON və YAML formatlarıdır. machine-readable output Misal olaraq: mytool --output json
 Bu, avtomatikliyi çox daha asanlaşdırır - digər alətlər standart parserləri istifadə edə bilərlər, lakin arxa, düzəltmə və ya pünktürasiyanın dəyişdirildiyi zaman çürüyə biləcək çirkin çərşənbə parsinguna təvəkkül edə bilər. Bununla yanaşı, insan oxumaq gücünü fəxr etməyin. Bir çox istifadəçilər alətinizi interaktiv şəkildə çalışdıracaqlar. 
 
 
 İnsan oxumaq üçün standart çıxışı (nicely formatted text) Bir bayrağı (yani --json və ya --format, əgər bir çox formatları dəstəkləymək istəyirsiniz) strukturlu çıxış üçün CLI alətləri də təmin edir Xatırladaq ki, bu, bir terminal üçün yazılır, amma JSON üçün başqa prosesə göndərilir. və ya Davranış auto-detection kubectl gh Yanlış mesajlar Düzgün bir mesaj belə olmalıdır: 
 
 
 
 Tədbir: Yanlış olanı açıqlayın Düşünürəm ki, necə düzəltmək olar Hər yerdə aynı tonu və strukturu istifadə Kötü məsələlər: Error: failed
 Daha yaxşı nümunə: Error: Could not open file '/tmp/input.txt' — file not found.
Hint: Verify that the path is correct and you have read permissions.
 Yaxşı hatalar işləmək istifadəçilərinizin vaxtını qurtarır və sizin alətinizə güvənməyə kömək edir. Dərslər və verboşluq Kullanıcılar nə qədər bilgi görürlərsə, onu kontrol etmək istəyirlər. tipik bir yaklaşım: 
 
 
 
 - Minimal işləmək üçün - Detaylı mesajlar üçün verboz -Developer-level tracing üçün debug Loglaşdırma düymələrini dizayn edin ki, istifadəçilər konteksti üçün doğru miktarda məlumat seçsinlər. Doğru çıxış kodları ilə birləşdirildikdə, bu düymələr borclanma və avtomatizasiya daha da düzgünlaşdırır. Reaksiya və performans Əgər CLI-nin ağır işləmələri varsa, və ya Misal olaraq: progress indicators spinners Downloading files... 45% complete
 Bununla yanaşı, alətin interaktiv modunda (t.b. scriptin bir hissəsi olaraq) çalışdığı zaman istisna olmayan animasiyalar və ya outputlardan qaçmaq lazımdır. Sonrakı Bir neçə ildir ki, bu proses çox asandır. - VİDEO Əsas səhifə » Xəbərlər » Əsas səhifə » Əsas səhifə » Əsas səhifə » Əsas səhifə » Əsas səhifə » Əsas səhifə » Əsas səhifə - bu, artıq istifadəçilərin necə çalışdığına uyğunlaşır. good Onu Bu kitabı oxuyuruq ki, bu məsələyə nə ehtiyac var: 
 
 
 
 
 
 
 Basitlik və fleksibiliteyi birləşdirən açıq və konsistent parametrlər Başarı və ya başarısızlığı bildirən anlamlı çıxış kodları STDOUT və STDERR-in diagnostikadan verileri ayırmaq üçün düzgün istifadə İnsanlar və maşınlar üçün yazılabilir və strukturlu çıxış formatları Düşünürəm ki, bu, bir neçə il əvvəlcədən baş verəcək. Ekosisteminizin konvensiyalarına tabe olun ki, alətiniz ilk dəfə tanıdılsın. Son olaraq, ən yaxşı CLI alətləri ortak bir xüsusiyyət paylaşır: onlar Onlar sürətli başlayır, sürətli baş verər, özlərini açıq-aşkar izah edərlər və daha böyük sistemlərə və skriptlərə müsbət daxil olurlar. respect the user’s time Bu prinsipləri xatırlayırsanız - istifadəçiləriniz üçün açıqlıq, konsistentlik və empati - CLI alətiniz yalnız Kullanmaq xoşbəxt olacaq. İşlər

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

Read My Stories

Bu audio hekayənin orijinal dilində hazırlanmışdır!

CLI-nin istifadə etməyi sevdiyiniz bir tool necə dizayn olunur?

About Author

ŞƏRHLƏR

ETİKET ASIN

BU MƏQALƏ TƏQDİM EDİLMİŞDİR

Related Stories

Optimizing Operations for Real Estate Investors - Interview with Startups of the Year Nominee, Azibo

Women in Tech: Azize Sultan Shares Her Inspiring Journey from Architecture to Tech Leadership

How Azarus's Technology is Transforming Viewer Engagement on Stream

Optimizing Operations for Real Estate Investors - Interview with Startups of the Year Nominee, Azibo

Women in Tech: Azize Sultan Shares Her Inspiring Journey from Architecture to Tech Leadership

How Azarus's Technology is Transforming Viewer Engagement on Stream

Light-Mode

Classic

Newspaper

Dark-Mode

Neon Noir

Minty

HN StartUps