perl - 如何通过命令行开关为我的 Perl 程序启用 Debug模式？

Question

我正在以“头脑优先”的方式学习 Perl。我绝对是这门语言的新手:

我正在尝试从 CLI 切换 debug_mode，它可以通过“打开和关闭”某些子例程来控制我的脚本的工作方式。

下面是我到目前为止所得到的:

#!/usr/bin/perl -s -w

# purpose : make subroutine execution optional,
# which is depending on a CLI switch flag

use strict;
use warnings;

use constant DEBUG_VERBOSE             => "v";
use constant DEBUG_SUPPRESS_ERROR_MSGS   => "s";
use constant DEBUG_IGNORE_VALIDATION     => "i";
use constant DEBUG_SETPPING_COMPUTATION  => "c";

our ($debug_mode);

mainMethod();

sub mainMethod # ()
{
    if(!$debug_mode)
    {
        print "debug_mode is OFF\n";
    }
    elsif($debug_mode)
    {
        print "debug_mode is ON\n";
    }
    else
    {
        print "OMG!\n";
        exit -1;
    }

    checkArgv();
    printErrorMsg("Error_Code_123", "Parsing Error at...");
    verbose();
}

sub checkArgv #()
{
    print ("Number of ARGV : ".(1 + $#ARGV)."\n");
}

sub printErrorMsg # ($error_code, $error_msg, ..)
{
    if(defined($debug_mode) && !($debug_mode =~ DEBUG_SUPPRESS_ERROR_MSGS))
    {
        print "You can only see me if -debug_mode is NOT set".
          " to DEBUG_SUPPRESS_ERROR_MSGS\n";
        die("terminated prematurely...\n") and exit -1;
    }
}

sub verbose # ()
{
    if(defined($debug_mode) && ($debug_mode =~ DEBUG_VERBOSE))
    {
        print "Blah blah blah...\n";
    }
}

据我所知，至少它有效......:

1. -debug_mode 开关不会干扰正常的 ARGV
2. 以下命令行有效:
   • ./可选.pl
   • ./可选.pl -debug_mode
   • ./可选.pl -debug_mode=v
   • ./可选.pl -debug_mode=s

但是，当多个debug_mode“混合”时，我会感到困惑，例如:

1. ./可选.pl -debug_mode=sv
2. ./可选.pl -debug_mode=vs

我不明白为什么上面的代码行“神奇地起作用”。

我看到“DEBUG_VERBOS”和“DEBUG_SUPPRESS_ERROR_MSGS”都适用于脚本，在本例中这很好。

但是，如果存在一些“冲突”的 Debug模式，我不知道如何设置“debug_modes 的优先级”？

此外，我不确定我的方法是否足以满足 Perlists 的要求，我希望我能朝着正确的方向迈进。

一个最大的问题是我现在把 if 语句放在里面我的大部分子程序用于在不同模式下控制它们的行为。这个可以吗？有没有更优雅的方式？

我知道必须有来自 CPAN 或其他地方的调试模块，但我想要一个真正的最小解决方案，除了“默认”模块之外，不依赖于任何其他模块。

而且我无法控制执行该脚本的环境...

Answer 1

要处理命令行选项，请查看 Getopt::Long 。您可以获得各种灵活的参数解析选项。

有很多很多处理日志记录的模块。 Log4Perl是一个非常流行的日志模块。

如果你真的非常想通过避免 CPAN 来限制自己(这是一个坏主意)你可以很容易地组合一个日志模块。

这是我为你编写的一个小程序。它需要测试和真实的文档等等。我还使用了一些高级技术，例如自定义 import() 方法。我使用单个变量来存储整个应用程序的调试设置也存在一些问题。但它有效。我在一个项目中使用了类似的模块，并且对此非常满意。

package QLOG;

use strict;
use warnings;
use Carp qw(croak);

our %DEBUG_OPTIONS;
our %VALID_DEBUG_OPTIONS;
our %DEBUG_CONFLICTS;

sub import {

    my $pkg = shift;
    my $target = caller();

    my %opts = @_;


    # Configure options

    croak "Must supply an array ref of valid modes"
       unless exists $opts{options};

    @VALID_DEBUG_OPTIONS{ @{$opts{options}} } = ();

    # Configure conflicts

    if( exists $opts{conflicts} ) {
        @DEBUG_CONFLICTS{ keys %{$opts{conflicts}} } 
            = values %{$opts{conflicts}}
    }

    # Export DEBUG method

    {   no strict 'refs';
        *{$target.'::DEBUG'} = \&DEBUG;
    }

    return;
}

sub DEBUG {
    my $mode = shift;

    croak "DEBUG mode undefined"
        unless defined $mode;

    return unless
        ( $mode eq 'ANY' and %DEBUG_OPTIONS )
        or exists $DEBUG_OPTIONS{$mode};

    warn "$_\n" for @_;

    return 1;
}


sub set_options {

    for my $opt ( @_ ) {
        die "Illegal option '$opt'"
           unless exists $VALID_DEBUG_OPTIONS{$opt};

        $DEBUG_OPTIONS{$opt}++;
    }

    return;
}

sub check_option_conflicts {

    for my $opt ( keys %DEBUG_OPTIONS ) {

        if (exists $DEBUG_CONFLICTS{$opt}) {

            for ( @{$DEBUG_CONFLICTS{$opt}} ) {

                die "Debug option $opt conflicts with $_" 
                    if exists $DEBUG_OPTIONS{$_} 
            }
        }
    }

    return;
}


1;

然后像这样使用它:

#!/usr/bin/perl 

use strict;
use warnings;


use Getopt::Long;

use QLOG
    options => [qw(
        VERBOSE
        SUPPRESS_ERROR_MSGS
        IGNORE_VALIDATION
        SETPPING_COMPUTATION
    )], 
    conflicts => {
        VERBOSE => [qw(
            SUPPRESS_ERROR_MSGS
            SETPPING_COMPUTATION
        )],
    };




process_args();

DEBUG VERBOSE => 'Command line data parsed.';

main();

### ---------------

sub main {

    DEBUG VERBOSE => 'BEGIN main()';

    if( DEBUG 'ANY' ) {
        print "debug_mode is ON\n";
    }
    else {
        print "debug_mode is OFF\n";
    }

    warn "Error which could be surpressed\n"
        unless DEBUG 'SUPPRESS_ERROR_MSGS';
}


# Get arguments and process flags like 'v' and 'sc' into strings specified
# in QLOG configuration above.
# This processing makes the nice DEBUG VERBOSE => 'blah'; syntax work.
sub process_args {

    # Use Getopt::Long to parse @ARGV

    my @debug_options;
    GetOptions (
        'debug-options=s@' => \@debug_options,
        'help'             => \&usage,
    ) or usage();

    # Convert option flags to strings.
    my %option_lut = qw(
        v  VERBOSE  
        s  SUPPRESS_ERROR_MSGS
        i  IGNORE_VALIDATION 
        c  SETPPING_COMPUTATION 
    );

    my @options = map {          # This chained map 
        exists $option_lut{$_}   #    looks in the lut for a flag
        ? $option_lut{$_}        #       translates it if found
        : $_                     #       or passes on the original if not.
    } 
    map {                        # Here we split 'cv' into ('c','v')
       split //
    } @debug_options;

    # Really should use Try::Tiny here.
    eval {    
        # Send a list of strings to QLOG
        # QLOG will make sure they are allowed.
        QLOG::set_options( @options );

        QLOG::check_option_conflicts(); 

        1;          # Ensure true value returned if no exception occurs.
    } or usage($@);

    return;
}

sub usage {

    my $message = shift || '';
    $message = '' if $message eq 'help';

    print <<"END";
$message

Use this proggy right.

END

    exit;
}

您可能想要添加一种方法来抑制调试消息。

类似于:

sub SUPPRESSED_BY {
     my $mode = shift;

     return if exists $DEBUG_OPTIONS{$mode);

     return @_; 
}

导出符号，然后使用它，如下所示:

DEBUG VERBOSE => SUPPRESSED_BY SUPPRESS_ERRORS => 'My message here';

日志记录模块可以轻松地组合在一起，从而导致存在大量可用的此类模块。完成此任务的方法有很多，而且在检测代码时要求也有不同的变化，甚至更多。我什至编写了一些日志模块来满足各种需求。

无论如何，当你一头扎进 Perl 时，这应该会让你在水中重重地扣一下。

请随意问我“到底是什么？”输入问题。我意识到我对你投入了很多。