PyPiCounter

Pypi-counter

Daftar isi

• Ringkasan
• Penggunaan Proyek
• Memulai
  • Mengimpor ke alat lain
  • Penggunaan yang berdiri sendiri
• Bantuan dan perbaikan bug
• Penulis

Ringkasan

• Proyek ini adalah alat yang, dengan sendirinya, akan memberikan bantuan kepada profesor ilmu komputer untuk membantu dalam penilaian penugasan. Alat ini akan menghitung dan mengeluarkan jumlah 'kesalahan umum' (misalnya, kelas tanpa docstring, fungsi tanpa docstring, dll.) Serta jumlah struktur komputasi umum (misalnya, fungsi, kelas, konstruksi looping, impor, dll.) Semua seperti yang ditentukan oleh pengguna dalam antarmuka baris perintah.

• Proyek ini juga dapat berfungsi sebagai peningkatan kolaboratif untuk mengimpor alat ini ke GatorGrader Allegheny College sendiri untuk membuat cek GatorGrader baru. Program ini menggunakan libcst, yang mem -parsing kode Python sebagai CST (pohon sintaks beton) yang membuat semua detail pemformatan (komentar, ruang putih, tanda kurung, dll.). Sebagai alat yang dirilis di PIPY, alat ini dapat diimpor ke alat penilaian otomatis lainnya juga.

Kegunaan proyek

• Di dalam libcst, ia memiliki banyak node untuk "mencocokkan" modul, ekspresi, dan pernyataan yang memungkinkan kami sebagai programmer untuk menyelesaikan cerita pengguna kami dengan cara yang lebih seragam. Proyek ini berguna karena eksplorasi libcst, yang pada akhirnya memungkinkan pengguna akhir untuk menentukan konstruk tertentu yang ingin mereka identifikasi dalam kode sumber (karena libcst akan menemukan semua kecocokan konstruk ini).

Memulai

Mengimpor ke alat penilaian lain

1. Instal dari PYPI dengan menjalankan poetry add pypi-counter di terminal Anda.
2. Impor paket Pypicounter dengan sintaks: from pypi_count.py_counter import PyPiCount .
3. Hubungi kelas PyPiCount pada file yang ditentukan dengan sintaks berikut: stored_path = PyPiCount("path_to_file") di seluruh contoh ini, stored_path adalah variabel instance yang menyimpan hasil dari file yang diuraikan. Fungsi harus dipanggil pada file parsed.
4. Jalankan fungsi dalam paket menggunakan sintaks stored_path.[function_name] . Misalnya, stored_path.count_comments()

Untuk hasil terbaik, kami sarankan menambahkan pernyataan cetak, karena fungsinya hanya akan mengembalikan jumlah konstruk yang ditentukan. Misalnya,

 console . print ( f"Number of comments in this file: { stored_path . count_comments () } " )

Akan menghasilkan:

 Number of comments in this file : 26

Daftar fungsi yang tersedia adalah:

 count_class_definitions ( file_name )                      
# returns the number of class definitions

count_comments ( file_name )                                
# returns the number of comments

count_import_statements ( file_name )                     
# returns the number of import statements

count_for_loops ( file_name )                           
# returns the number of for loops

count_while_loops ( file_name )                           
# returns the number of while loops

count_function_definitions ( file_name )            
# returns the number of function definitions  

count_functions_without_docstrings ( file_name )         
# returns the number of functions without docstrings

count_functions_with_docstrings ( file_name )          
# returns the number of functions with docstrings

count_classes_with_docstrings ( file_name )                  
# returns the number of classes with docstrings

count_classes_without_docstrings ( file_name )             
# returns the number of classes without docstrings

count_function_parameters ( file_name , function_name )    
# returns the number of function parameters
# after specifying the function name

count_assignment_statements ( file_name )              
# returns the number of assignment statements

count_augmented_assignment_statements ( file_name )
# returns the number of assignment statements that include
an augmented assignment operator ( + = , -= )

Penggunaan yang berdiri sendiri

Pengguna dapat memulai dengan proyek ini dengan mengikuti langkah -langkah berikut:

1. Instal paket dengan PIP, menggunakan pip install pypi-counter atau pipx install pypi-counter
2. Untuk membiasakan diri dengan argumen yang diterima untuk proyek ini, jalankan poetry run pypicount --help . Perintah ini menampilkan semua argumen berbeda yang dapat dilewati. Daftar argumen yang berbeda tercantum di bawah ini:

 Usage : pypicount [ OPTIONS ] INPUT_FILE

Main method to display the different options .

Arguments :
INPUT_FILE  [ required ]

Options :
- - class - definitions             [ default : False ]
- - import - statements             [ default : False ]
- - comments                      [ default : False ]
- - function - definitions          [ default : False ]
- - if - statements                 [ default : False ]
- - function - without - docstrings   [ default : False ]
- - function - with - docstrings      [ default : False ]
- - class - with - docstrings         [ default : False ]
- - class - without - docstrings      [ default : False ]
- - function - parameters TEXT
- - assignment - statements         [ default : False ]
- - augmented - assignment - statements
                                [ default : False ]
- - while - loops                   [ default : False ]
- - for - loops                     [ default : False ]
- - install - completion            Install completion for the current shell .
- - show - completion               Show completion for the current shell , to
                                copy it or customize the installation .

- - help                          Show this message and exit .

Ini adalah berbagai jenis argumen yang akan diterima Pypicount dalam rilis ini.

Setelah Anda menemukan argumen yang Anda pilih, jalankan yang berikut:

 poetry run pypicount - - [ argument ] - - input - file path / to / file 

Contoh output

Perintah Jalankan Sampel:

 poetry run pypicount - - class - with - docstrings - - input - file tests / input / sample_file . py

Output sampel:

 # of functions with docstrings: 1 

Bantuan dan perbaikan bug

• Pengguna yang mengalami kesulitan dalam menavigasi program dapat datang ke Readme untuk mendapatkan bantuan.
• Pengguna juga dapat membuka masalah pada pelacak edisi kami dengan format berikut:
  • Jelaskan bug
  • Sertakan langkah -langkah untuk mereplikasi bug
  • Perilaku yang diharapkan
  • Tangkapan layar
  • OS desktop

Penulis

• Orang -orang yang memelihara dan berkontribusi pada proyek ini
  • Alexis Caldwell, @caldwella2
  • Adriana Solis, @solisa986
  • Rachael Harris, @rachaelharris
  • Ramon Guzman, @guzmanr04
  • Ryan Hilty, @ryanhiltyallegheny