{"id":3162,"date":"2022-01-31T16:47:24","date_gmt":"2022-01-31T15:47:24","guid":{"rendered":"https:\/\/weeeopen.polito.it\/?p=3162"},"modified":"2023-10-17T20:51:24","modified_gmt":"2023-10-17T18:51:24","slug":"come-installare-e-configurare-pre-commit-per-python","status":"publish","type":"post","link":"https:\/\/weeeopen.polito.it\/en\/come-installare-e-configurare-pre-commit-per-python\/","title":{"rendered":"Come installare e configurare pre-commit per Python"},"content":{"rendered":"

Il framework pre-commit <\/strong>\u00e8 un tool utilissimo per lo sviluppatore che permette di mantenere sempre il codice in linea con i vari standard di scrittura.<\/p>\n\n\n\n

Nel caso del Python, si parla dello standard PEP8<\/strong> che stabilisce le varie convenzioni nella scrittura e interpretazione del codice.<\/p>\n\n\n\n

Lo scopo di questa guida \u00e8 fornire al lettore tutti i passaggi per configurare nella maniera pi\u00f9 semplice possibile il framework pre-commit sui propri repository locali, utilizzando il “correttore” black <\/strong>per la formattazione del codice.<\/p>\n\n\n\n

Requisiti<\/h2>\n\n\n\n

Come punto di partenza \u00e8 necessario avere:<\/p>\n\n\n\n

  • Repository locale git<\/li>
  • Python 3<\/li>
  • pip<\/li>
  • Terminale<\/li><\/ul>\n\n\n\n

    Installazione<\/h2>\n\n\n\n

    Ipotizziamo che il nostro repository si chiami WEEEOpen<\/strong>.<\/p>\n\n\n\n

    Apriamo il terminale <\/strong>(o powershell <\/strong>su Windows) e spostiamoci nella cartella del repository:<\/p>\n\n\n\n

    cd WEEEOpen<\/code><\/pre>\n\n\n\n
    Installiamo pre-commit <\/strong>sul nostro sistema:<\/p>\n\n\n\n
    pip install pre-commit<\/code><\/pre>\n\n\n\n
    Procediamo con l’installazione di pre-commit<\/strong> nel nostro repository col comando:<\/p>\n\n\n\n
    pre-commit install<\/code><\/pre>\n\n\n\n
    Ora che l’installazione \u00e8 terminata possiamo procedere con la configurazione.<\/p>\n\n\n\n
    Configurazione<\/h2>\n\n\n\n
    Una volta terminata l’installazione, creiamo nella cartella del repository il file di configurazione di pre-commit<\/strong>:<\/p>\n\n\n\n
    touch .pre-commit-config.yaml<\/code><\/pre>\n\n\n\n
    Apriamo questo file con un qualsiasi editor di testo e inseriamo la seguente configurazione:<\/p>\n\n\n\n
    repos:\n  - repo: https:\/\/github.com\/psf\/black\n    rev: 22.1.0\n    hooks:\n      - id: black\n        types:\n          - python<\/code><\/pre>\n\n\n\n
    Il tag repos<\/code> indica l’insieme di tutti i repository dei tool che pre-commit <\/strong>dovr\u00e0 utilizzare prima dei nostri commit.<\/p>\n\n\n\n
    In repo<\/code> inseriamo il link al repository di black<\/strong>, in rev<\/code> la versione che desideriamo (non \u00e8 necessariamente quella in esempio) e negli hooks<\/code> specifichiamo tutti i parametri per l’esecuzione dello script black <\/strong>(in questo caso solo l’id e i tipi di file che deve controllare).<\/p>\n\n\n\n
    Ovviamente, oltre a black<\/strong>, \u00e8 possibile inserire ulteriori hooks in base alle nostre esigenze.<\/p>\n\n\n\n
    Conclusione<\/h2>\n\n\n\n
    Ora che il framework \u00e8 configurato, possiamo procedere con la scrittura del nostro codice e, nel momento in cui l’utente effettuer\u00e0 un nuovo commit, pre-commit<\/strong> eseguir\u00e0 tutti gli script necessari per formattare il nostro codice secondo gli standard corretti.<\/p>","protected":false},"excerpt":{"rendered":"
    Il framework pre-commit \u00e8 un tool utilissimo per lo sviluppatore che permette di mantenere sempre il codice in linea con i vari standard di scrittura. Nel caso del Python, si parla dello standard PEP8 che stabilisce le varie convenzioni nella scrittura e interpretazione del codice. Lo scopo di questa guida \u00e8 fornire al lettore tutti […]<\/p>\n","protected":false},"author":15,"featured_media":3169,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"episode_type":"","audio_file":"","podmotor_file_id":"","podmotor_episode_id":"","cover_image":"","cover_image_id":"","duration":"","filesize":"","filesize_raw":"","date_recorded":"","explicit":"","block":"","ocean_post_layout":"","ocean_both_sidebars_style":"","ocean_both_sidebars_content_width":0,"ocean_both_sidebars_sidebars_width":0,"ocean_sidebar":"0","ocean_second_sidebar":"0","ocean_disable_margins":"enable","ocean_add_body_class":"","ocean_shortcode_before_top_bar":"","ocean_shortcode_after_top_bar":"","ocean_shortcode_before_header":"","ocean_shortcode_after_header":"","ocean_has_shortcode":"","ocean_shortcode_after_title":"","ocean_shortcode_before_footer_widgets":"","ocean_shortcode_after_footer_widgets":"","ocean_shortcode_before_footer_bottom":"","ocean_shortcode_after_footer_bottom":"","ocean_display_top_bar":"default","ocean_display_header":"default","ocean_header_style":"","ocean_center_header_left_menu":"0","ocean_custom_header_template":"0","ocean_custom_logo":0,"ocean_custom_retina_logo":0,"ocean_custom_logo_max_width":0,"ocean_custom_logo_tablet_max_width":0,"ocean_custom_logo_mobile_max_width":0,"ocean_custom_logo_max_height":0,"ocean_custom_logo_tablet_max_height":0,"ocean_custom_logo_mobile_max_height":0,"ocean_header_custom_menu":"0","ocean_menu_typo_font_family":"0","ocean_menu_typo_font_subset":"","ocean_menu_typo_font_size":0,"ocean_menu_typo_font_size_tablet":0,"ocean_menu_typo_font_size_mobile":0,"ocean_menu_typo_font_size_unit":"px","ocean_menu_typo_font_weight":"","ocean_menu_typo_font_weight_tablet":"","ocean_menu_typo_font_weight_mobile":"","ocean_menu_typo_transform":"","ocean_menu_typo_transform_tablet":"","ocean_menu_typo_transform_mobile":"","ocean_menu_typo_line_height":0,"ocean_menu_typo_line_height_tablet":0,"ocean_menu_typo_line_height_mobile":0,"ocean_menu_typo_line_height_unit":"","ocean_menu_typo_spacing":0,"ocean_menu_typo_spacing_tablet":0,"ocean_menu_typo_spacing_mobile":0,"ocean_menu_typo_spacing_unit":"","ocean_menu_link_color":"","ocean_menu_link_color_hover":"","ocean_menu_link_color_active":"","ocean_menu_link_background":"","ocean_menu_link_hover_background":"","ocean_menu_link_active_background":"","ocean_menu_social_links_bg":"","ocean_menu_social_hover_links_bg":"","ocean_menu_social_links_color":"","ocean_menu_social_hover_links_color":"","ocean_disable_title":"default","ocean_disable_heading":"default","ocean_post_title":"","ocean_post_subheading":"","ocean_post_title_style":"","ocean_post_title_background_color":"","ocean_post_title_background":0,"ocean_post_title_bg_image_position":"","ocean_post_title_bg_image_attachment":"","ocean_post_title_bg_image_repeat":"","ocean_post_title_bg_image_size":"","ocean_post_title_height":0,"ocean_post_title_bg_overlay":0.5,"ocean_post_title_bg_overlay_color":"","ocean_disable_breadcrumbs":"default","ocean_breadcrumbs_color":"","ocean_breadcrumbs_separator_color":"","ocean_breadcrumbs_links_color":"","ocean_breadcrumbs_links_hover_color":"","ocean_display_footer_widgets":"default","ocean_display_footer_bottom":"default","ocean_custom_footer_template":"0","ocean_post_oembed":"","ocean_post_self_hosted_media":"","ocean_post_video_embed":"","ocean_link_format":"","ocean_link_format_target":"self","ocean_quote_format":"","ocean_quote_format_link":"post","ocean_gallery_link_images":"off","ocean_gallery_id":[],"footnotes":""},"categories":[1],"tags":[23,20],"ppma_author":[170],"class_list":["post-3162","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-blog","tag-divulgazione","tag-tutorial","entry","has-media"],"authors":[{"term_id":170,"user_id":15,"is_guest":0,"slug":"palmi","display_name":"Niccol\u00f2 Palmieri","avatar_url":"https:\/\/secure.gravatar.com\/avatar\/a013c919519414c1b75f9f42f9bfe72e93a234e7e8b149c93038e42ca83bca3f?s=96&d=retro&r=g","0":null,"1":"","2":"","3":"","4":"","5":"","6":"","7":"","8":""}],"_links":{"self":[{"href":"https:\/\/weeeopen.polito.it\/en\/wp-json\/wp\/v2\/posts\/3162","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/weeeopen.polito.it\/en\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/weeeopen.polito.it\/en\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/weeeopen.polito.it\/en\/wp-json\/wp\/v2\/users\/15"}],"replies":[{"embeddable":true,"href":"https:\/\/weeeopen.polito.it\/en\/wp-json\/wp\/v2\/comments?post=3162"}],"version-history":[{"count":1,"href":"https:\/\/weeeopen.polito.it\/en\/wp-json\/wp\/v2\/posts\/3162\/revisions"}],"predecessor-version":[{"id":3631,"href":"https:\/\/weeeopen.polito.it\/en\/wp-json\/wp\/v2\/posts\/3162\/revisions\/3631"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/weeeopen.polito.it\/en\/wp-json\/wp\/v2\/media\/3169"}],"wp:attachment":[{"href":"https:\/\/weeeopen.polito.it\/en\/wp-json\/wp\/v2\/media?parent=3162"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/weeeopen.polito.it\/en\/wp-json\/wp\/v2\/categories?post=3162"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/weeeopen.polito.it\/en\/wp-json\/wp\/v2\/tags?post=3162"},{"taxonomy":"author","embeddable":true,"href":"https:\/\/weeeopen.polito.it\/en\/wp-json\/wp\/v2\/ppma_author?post=3162"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}