updating release repo

Author: Hsin Yuan Yeh

LICENSE.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Hsin Yuan Yeh
+Copyright (c) 2023 Hsin Yuan Yeh
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.rst

@@ -82,7 +82,7 @@ SSHScript is a powerful tool for system automation, and it is easy to use, even
 Releases
 ========
 
-The new experimental release is 2.0.2 (2023/10/6). There are lots of changes, but documentation is not available yet.
+The new experimental release is 2.0.2 (2023/10/6). There are lots of changes, but documentation is on working.
 
 The last stable version is 1.1.17. (2022/9/22). Relase Notes_
 

setup.cfg

@@ -1,7 +1,7 @@
 [metadata]
-description=write automation scripts for ssh and subprocess in python
+description=Write Python scripts to automate SSH and subprocess operations.
 description_file = README.rst
 version = attr: sshscript.__version__
 [options]
-python_requires = >=3.7.0
+python_requires = >=3.8
 package_dir = =src

src/sshscript/sshscriptchannel.py

@@ -189,11 +189,16 @@ def exitcode(self):
     @property
     def stdout(self):
         return self.channel._exitcodePatternForClean.sub(r'\1',self.channel.stdout)
-        #return self.channel.stdout
     @property
     def stderr(self):
         return self.channel._exitcodePatternForClean.sub(r'\1',self.channel.stderr)
-        #return self.channel.stderr
+    @property
+    def rawstdout(self):
+        return self.channel.rawstdoutForOwner()
+    @property
+    def rawstderr(self):
+        return self.channel.rawstderrForOwner()
+    
     def trim(self,text):
         return self.channel.trim(text)
 
@@ -248,6 +253,8 @@ def __init__(self,owner):
         ## assign owner's stdout and stderr
         self.owner._stdout = self.stdoutForOwner
         self.owner._stderr = self.stderrForOwner
+        self.owner._rawstdout = self.rawstdoutForOwner
+        self.owner._rawstderr = self.rawstderrForOwner
         self.shellToRun = self.owner.shellToRun
         self.stdoutDumpBuf = []
         self.stderrDumpBuf = []
@@ -517,6 +524,13 @@ def stdoutForOwner(self):
     def stderrForOwner(self):
         ## because we no more setup prompt, to strip out prompt is not necessary
         return (self._exitcodePatternForClean.sub(r'\1',self.trim((b''.join(self.allStderrBuf)).decode('utf8','replace'))))
+    def rawstdoutForOwner(self):
+        ## because we no more setup prompt, to strip out prompt is not necessary
+        return (b''.join(self.allStdoutBuf))
+    def rawstderrForOwner(self):
+        ## because we no more setup prompt, to strip out prompt is not necessary
+        return (b''.join(self.allStderrBuf))
+
     def trimedStdoutForOwner(self):
         ## because we no more setup prompt, to strip out prompt is not necessary
         return self.trim((b''.join(self.allStdoutBuf)).decode('utf8','replace'))
@@ -752,7 +766,6 @@ def sendline(self,line,outputTimeout=None,outputType=None,waitPrompt=None):
             if idx > 0 : self.wait(self.waitingInterval,30)
             '''
             self.send(line+newline)
-            
             if idx < len(lines) - 1:
                 ## not the last one
                 self.waitCommandToComplete(outputTimeout,waitPrompt)
@@ -855,8 +868,9 @@ def addStderrData(self,newbytes):
         if lines is not None:
             if self.stderrListener:
                 self.stderrListener(2,[x+bNewline for x in lines])
-            sys.stderr.buffer.write(bNewline.join([self.stderrPrefix + x  for x in lines])+bNewline)
-            sys.stderr.buffer.flush()
+            if self.dump2sys:
+                sys.stderr.buffer.write(bNewline.join([self.stderrPrefix + x  for x in lines])+bNewline)
+                sys.stderr.buffer.flush()
     def close(self):
         ## dump the last content in stdoutDumpBuf and stderrDumpBuf
         ## No need to call self.updateStdoutStderr()
@@ -927,10 +941,10 @@ def _win32ReadingStdout():
                 def _reading():
                     buffer = {
                         self.masterFd[0]: self.addStdoutData,  #stdout
-                        #self.masterFd[1]: self.addStderrData  #stderr
+                        self.masterFd[1]: self.addStderrData  #stderr
                     }
-                    if len(self.masterFd) == 2:
-                        buffer[self.masterFd[1]]= self.addStderrData
+                    #if len(self.masterFd) == 2:
+                    #    buffer[self.masterFd[1]]= self.addStderrData
                     #while (not self.closed) and buffer:
                     while (self.cp.poll() is None):
                         try:
@@ -976,8 +990,10 @@ def commandTimeout(self):
         return self.owner.commandTimeout
 
     def send(self,s):
-        self.log(DEBUG,f'{threading.current_thread().native_id} send:{[s]}')
+        ## disable, sensitive data might be shown
+        #self.log(DEBUG,f'{threading.current_thread().native_id} send:{[s]}')
         os.write(self.stdin,s.encode('utf-8'))
+        ## this would crashed in linux for pty 
         #os.fsync(self.stdin)
 
     def close(self):

src/sshscript/sshscriptchannelutils.py

@@ -42,30 +42,25 @@ def expect(self,outputTimeout):
         timeout = 3
         if self.pattern is None:
             ## failover to channel's default wait() method
-            logger.debug(f'****** ****** ******1 prompt {self} failover to wait()')
             self.channel.wait(outputTimeout)
         elif self._type == 1:
             try:
                 m = self.channel.expect(self.pattern,timeout=timeout,stdout=True,stderr=False,position=self.position)
             except TimeoutError:
-                logger.debug(f'****** ****** ****** prompt {self} not matched')
                 logger.debug(f'stdout={self.channel.stdout}')
                 raise
             else:
                 self.position += m.end() + 1
-                logger.debug(f'****** ****** ******2 prompt {self} matched')
                 ## ensure all data has been received
                 self.channel.wait(0.1)
         elif self._type == 2:
             try:
                 m = self.channel.expect(self.pattern,timeout=timeout,stdout=False,stderr=True,position=self.position)
             except TimeoutError:
-                logger.debug(f'****** ****** ****** prompt {self} not matched')
                 logger.debug(f'stderr={self.channel.stderr}')
                 raise
             else:
                 self.position += m.end() + 1
-                logger.debug(f'****** ****** ******3 prompt {self} matched')
                 ## ensure all data has been received
                 self.channel.wait(0.1)
         else:
@@ -77,7 +72,7 @@ def __call__(self,keyword,stdout=False,stderr=False):
         self.keyword = keyword
         if stdout: self.type = 1
         elif stderr: self.type = 2
-        logger.debug(f'** __call__ set prompt to "{self}" ({stdout},{stderr})')
+        logger.debug(f'__call__ set prompt to "{self}" ({stdout},{stderr})')
     @property
     def keyword(self):
         return self._keyword

src/sshscript/sshscriptdollar.py

@@ -88,6 +88,8 @@ def __init__(self,sshscript,cmd=None,globals=None,locals=None,inWith=False,fr=0)
         self.cp = None # got value if run by subprocess and inWith
         self._stdout = lambda: ""
         self._stderr = lambda: ""
+        self._rawstdout = lambda: ""
+        self._rawstderr = lambda: ""
         self.stdin = None
         self.exitcode = None
         self.inWith = inWith
@@ -108,6 +110,13 @@ def stdout(self):
     def stderr(self):
         return self._stderr()
 
+    @property
+    def rawstdout(self):
+        return self._rawstdout()
+    @property
+    def rawstderr(self):
+        return self._rawstderr()
+
     @property
     def waitingInterval(self):
         ## v2.0 CMD_INTERVAL and SSH_CMD_INTERVAL renamed to OUTPUT_TIMEOUT and SSH_OUTPUT_TIMEOUT
@@ -436,7 +445,6 @@ def execBySSH(self,isTwodollars):
                 self.channel.updateStdoutStderr('not self.inWith')
                 ## this would assign value of self.exitcode
                 self.channel.close()
-                print('^' * 100,self.exitcode)
                 error = self.checkExitcode(self.exitcode,self.channel.stderr)
                 if error: raise error
         else:

src/sshscript/sshscriptsession.py

@@ -764,7 +764,6 @@ def _run(script,varLocals,varGlobals,showScript=False):
                 digits = len(str(len(lines)+1))
                 for line in lines:
                     self.lineNumberCount += 1
-                    #print(f'{str(self.lineNumberCount).zfill(digits)}:{line}')
                     print(f'{line}')
                 print()
                 return {}