bagbag 0.74.15

An all in one python library

bagbag

An all in one python library

Install

pip3 install bagbag --upgrade

Docker

docker run --rm --name bagbag -v /path/to/file/run.py:/app/run.py darren2046/bagbag:latest
docker run --rm --name bagbag -v /path/to/file/run.py:/app/run.py darren2046/bagbag-gui:latest # xvfb running so can use gui application such as chromedriver with selenium
docker run --rm --name bagbag -v /path/to/file/run.py:/app/run.py darren2046/bagbag-gui-debug:latest # HTTP Server serving vnc desktop runing on port 80

Library

• Crypto

  • AES(key:str, mode:str="cfb")
    • Encrypt(raw:str) -> str
    • Decrypt(enc:str) -> str

• File(path:str)

  • Write(data:str)
  • Append(data:str)

• Lg 日志模块

  • Lg.SetLevel(level:日志级别:str)
  • Lg.SetFile(path:日志路径:str, size:文件大小，MB:int, during:日志保留时间，天:int, color:是否带ANSI颜色:bool=True, json:是否格式化为json:bool=False)
  • Lg.Debug(message:str)
  • Lg.Trace(message:str)
  • Lg.Info(message:str)
  • Lg.Warn(message:str)
  • Lg.Error(message:str)

• String(string:str) 一些字符串处理函数

  • HasChinese() -> bool 是否包含中文
  • Language() -> str 语言
  • Repr() -> str
  • SimplifiedChineseToTraditional() -> str
  • TraditionalChineseToSimplified() -> str
  • Ommit(length:int) -> str
  • Filter(chars:str="1234567890qwertyuioplkjhgfdsazxcvbnmQWERTYUIOPLKJHGFDSAZXCVBNM") -> str
  • Len() -> int
  • IsIPAddress() -> bool

• Time 时间

  • Strftime(timestamp:float|int, format:str="%Y-%m-%d %H:%M:%S") -> str
  • Strptime(timestring:str, format:str=None) -> int

• Base64

  • Encode(s:str|bytes) -> str
  • Decode(s:str) -> str|bytes

• Json

  • Dumps(obj, indent=4, ensure_ascii=False) -> str
  • Loads(s:str) -> list | dict
  • ExtraValueByKey(obj:list|dict, key:str) -> list

• Hash

  • Md5sum(string:str) -> str
  • Md5sumFile(fpath:str, block_size=2**20) -> str
  • Sha256sum(data:str|bytes) -> str
  • Sha256sumFile(fpath:str, block_size=2**20) -> str

• Os

  • Exit(num:int=0)
  • Mkdir(path:str)
  • Getenv(varname:str, defaultValue:str=None) -> str | None
  • ListDir(path:str) -> list[str]
  • Unlink(path:str)
  • Move(src:str, dst:str, force:bool=True)
  • Copy(src:str, dst:str, force:bool=True)
  • Path
    • Basedir(path:str) -> str
    • Join(*path) -> str
    • Exists(path:str) -> bool
    • Uniquify(path:str) -> str
    • IsDir(path:str) -> bool
    • Basename(path:str) -> str

• Http

  • Head(url:str, Timeout:str=None, ReadBodySize:int=None, FollowRedirect:bool=True, HttpProxy:str=None, TimeoutRetryTimes:int=0, InsecureSkipVerify:int=False,Debug:bool=False)
  • Get(url:str, Timeout:str=None, ReadBodySize:int=None, FollowRedirect:bool=True, HttpProxy:str=None, TimeoutRetryTimes:int=0, InsecureSkipVerify:int=False,Debug:bool=False)
  • PostRaw(url:str, Data:str, Timeout:str=None, ReadBodySize:int=None, FollowRedirect:bool=True, HttpProxy:str=None, TimeoutRetryTimes:int=0, InsecureSkipVerify:int=False,Debug:bool=False)
  • PostJson(url:str, Json:dict,Timeout:str=None, ReadBodySize:int=None, FollowRedirect:bool=True, HttpProxy:str=None, TimeoutRetryTimes:int=0, InsecureSkipVerify:int=False,Debug:bool=False)
  • PostForm(url:str, Data:dict, Timeout:str=None, ReadBodySize:int=None, FollowRedirect:bool=True, HttpProxy:str=None, TimeoutRetryTimes:int=0, InsecureSkipVerify:int=False,Debug:bool=False)
  • Delete(url:str, Timeout:str=None, ReadBodySize:int=None, FollowRedirect:bool=True, HttpProxy:str=None, TimeoutRetryTimes:int=0, InsecureSkipVerify:int=False,Debug:bool=False)
  • PutForm(url:str, Data:dict,Timeout:str=None, ReadBodySize:int=None, FollowRedirect:bool=True, HttpProxy:str=None, TimeoutRetryTimes:int=0, InsecureSkipVerify:int=False,Debug:bool=False)
  • PutRaw(url:str, Data:str, Timeout:str=None, ReadBodySize:int=None, FollowRedirect:bool=True, HttpProxy:str=None, TimeoutRetryTimes:int=0, InsecureSkipVerify:int=False, Debug:bool=False)
  • PutJson(url:str, Json:dict, Timeout:str=None, ReadBodySize:int=None, FollowRedirect:bool=True, HttpProxy:str=None, TimeoutRetryTimes:int=0, InsecureSkipVerify:int=False,Debug:bool=False)

• Socket

  • TCP
    • Listen(host:str, port:int, waitQueue:int=5)
      • Accept() -> Chan[StreamConnection]
      • AcceptOne() -> StreamConnection
    • Connect(host:str, port:int) -> StreamConnection
      • PeerAddress() -> TCPPeerAddress
      • Send(data:str)
      • SendBytes(data:bytes)
      • Recv(length:int) -> str
      • RecvBytes(length:int) -> bytes
      • Close()

• Random

  • Int(min:int, max:int) -> int
  • Choice(obj:list|str) -> Any
  • String(length:int, charset:str="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789") -> str
  • Shuffle(li:list) -> list

• Funcs

  • Markdown2Html(text:str) -> str
  • Wget(url:str, dest:str=None, override=True)
  • IP2Int(ip:str) -> int
  • Int2IP(intip:int) -> str
  • ResizeImage(src:str, dst:str, width:int, quality:int=95)
  • UUID() -> str
  • CutSentence(sentence:str, filter:bool=True) -> list[str]

• Tools 一些工具

  • Cache

    • LRU(size:int) -> dict
    • FIFO(size:int) -> dict
    • LFU(size:int) -> dict
    • MRU(size:int) -> dict
    • RR(size:int) -> dict
    • TTL(size:int) -> dict

  • OCR(server:str)

    • Recognition(fpath:str, lang:str="ch") -> ocrResult
      • SaveImage(fpath:str)

  • WebCrawler()

    • Run(self, url:str) -> typing.Iterable[WebCrawlerResult]

  • JavaScript

    • Eval(code:str)

  • BlockChain

    • Tron
      • TronClient(fullNodeServer:str)
        • Block(blockNumber:int) -> tronBlock
          • Transcations() -> list[tronTranscation]
      • TronContract(address:str)
        • Info()
        • Address()
      • TronAsset(name:str)
        • Info()
        • Name()
    • Binance
      • OfficalAccountVertify
        • Twitter(account:str, waiteOnRateLimit:bool=True) -> bool
      • GetPrice(pair:str|list=None) -> CoinsPairPrice | list[CoinsPairPrice]

  • Twitter

    • Essential(bearerToken:str)
      • Search(keyword:str, sinceID:int=None, tweetPerRequest:int=10) -> typing.Iterable[twitterTweet]
      • Timeline(screename:str, sinceID:int=None, tweetPerRequest:int=10) -> typing.Iterable[twitterTweet]
    • Elevated(consumer_key:str, consumer_secret:str)
      • Search(keyword:str, days:int=7) -> typing.Iterable[twitterTweet]
      • Timeline(screename:str) -> typing.Iterable[twitterTweet]
      • Followers(screename:str) -> typing.Iterable[twitterUser]

  • Nslookup(server:list[str]=["8.8.8.8", "1.1.1.1", "8.8.4.4"], tcp:bool=False)

    • A(domain:str) -> list[str]
    • AAAA(domain:str) -> list[str]

  • MatrixBot(apiserver:str, password:str="")

    • SetRoom(room:str) -> MatrixBot
    • Send(message:str)
    • SendImage(path:str)
    • GetMessage(num:int=10) -> list[MatrixBotMessage]
      • Reply(message:str)
      • ReplyImage(path:str)

  • RSS

    • Opml(opmlurl:str) -> list[RSSFeed]
    • Feed(feedurl:str) -> list[RSSPage]

  • Queue(server:str, name:str, length:int=0, timeout:int=300)

    • QueueConfirm(name:str, length:int=0, timeout:int=300) -> queueQueueConfirm
      • Put(item:typing.Any, force:bool=False)
      • Get(self) -> typing.Tuple[str, typing.Any]
      • Done(tid:str)
      • Size(self) -> int

  • Kafka(topic:str, servers:str|list)

    • Producer(value_serializer=lambda m: json.dumps(m).encode()) -> KafkaProducer
      • Send(data:dict)
    • Consumer(group_id:str=None, auto_offset_reset:str='earliest') -> KafkaConsumer
      • Get() -> dict

  • Github(token:str, ratelimit:str="30/m")

    • Search(pattern:str) -> GithubSearchResults
      • Get() -> GithubSearchResult | None

  • SSH(host:str, port:int=None, user:str=None, password:str=None, pkey:str=None)

    • GetOutput(command:str) -> str
    • Close()
    • Upload(localpath:str, remotepath:str=None)
    • Download(remotepath:str, localpath:str=None)
    • FileInfo(filepath:str)
    • ListDir(dirpath:str=".") -> dict

  • Translater

    • Baidu(appid:str, secretkey:str)
      • SetLang(To:str="zh", From:str="auto") -> Baidu
      • Translate(text:str) -> dict
    • Google(httpProxy:str=None)
      • SetLang(To:str="zh-CN", From:str="auto") -> Google
      • Translate(text:str, format:str="html") -> str

  • XPath(html:str)

    • Find(xpath:str) -> XPath | None
    • Attribute(name:str) -> str | None
    • Text() -> str
    • Html() -> str

  • WaitGroup()

    • Add()
    • Done()
    • Wait()

  • Crontab()

    • Every(interval: int = 1) -> Crontab
    • Second() -> Crontab
    • Minute() -> Crontab
    • Hour() -> Crontab
    • Day() -> Crontab
    • Week() -> Crontab
    • At(time: str) -> Crontab
    • Do(job_func, *args, **kwargs)
    • Monday()
    • Tuesday()
    • Wednesday()
    • Thursday()
    • Friday()
    • Saturday()
    • Sunday()

  • Elasticsearch(url:str)

    • Delete(IndexName:str)
    • Collection(IndexName:str)
      • Index(id:int, data:dict, refresh:bool=False, Timeout:int=15)
      • Refresh(Timeout:int=15)
      • Delete(id:int)
      • Search(key:str, value:str, page:int=1, pagesize:int=50, OrderByKey:str=None, OrderByOrder:str="ase", Highlight:str=None, mustIncludeAllWords:bool=True)

  • CSV

    • Reader(fpath:str)
      • Read() -> dict
      • Close()
    • Writer(fpath:str, mode:str="w")
      • SetHeaders(*headers)
      • Write(row:dict[str])
      • Close()
      • Flush()

  • Xlsx

    • Reader(fpath:str)
      • Read() -> dict
      • Close()
    • Writer(fpath:str, mode:str="w")
      • SetHeaders(*headers)
      • Write(row:dict[str])
      • Close()
      • Flush()

  • WebServer(name:str=None) # 例子见源码文件Web.py的后半部分

    • Run(host:str, port:int, block:bool=True) # 监听HTTP服务
    • Route: (path:str, methods:list=["GET", "HEAD", "OPTIONS"]) # 例子见Web.py文件, 是一个装饰器
    • Request()
      • Method() -> str # 请求的HTTP方法
      • Json() -> dict | list # 格式化请求的post内容为json
      • Data() -> str # post的http的body
      • Form()
        • Get(name:str, default:str="") -> str | None # 获取表单的数据
      • Args()
        • Get(name:str, default:str="") -> str | None # 获取URL的参数

  • Chan() 内存队列, 跟go的chan一样

  • RateLimit(rate:str, sleep:bool=True) rate可以是 次数/时间区间, 时间可以是s, m, h, d, 即秒,分,时,天. 例如一分钟限制五次: 5/m. 在低速率的时候能限制准确, 例如低于1秒10次. 高速率例如每秒50次以上, 实际速率会降低, 速率越高降低越多.

    • Take() sleep=True的时候会添加一个sleep, 可以把请求平均在时间段内. 在低速率的时候能限制准确. 高速率例如每秒50次以上, 实际速率会降低, 速率越高降低越多. sleep=False的时候没有sleep, 会全在一开始扔出去, 然后block住, 等下一个周期, 在需要速率很高的时候可以这样, 例如发包的时候, 一秒限制2000个包这样.

  • URL(url:str)

    • Parse() -> URLParseResult
    • Encode() -> str
    • Decode() -> str

  • Prometheus

    • MetricServer(listen:str="0.0.0.0", port:int=9105)
    • PushGateway(address:str, job:str, pushinterval:int=15, instance:str=None)
      • NewCounter(name:str, help:str) -> prometheusCounter
        • Add(num:int|float=1)
      • NewCounterWithLabel(name:str, labels:list[str], help:str) -> prometheusCounterVec
        • Add(labels:dict|list, num:int|float=1)
      • NewGauge(name:str, help:str) -> prometheusGauge
        • Set(num:int|float)
      • NewGaugeWithLabel(name:str, labels:list[str], help:str) -> prometheusGaugeVec
        • Set(labels:dict|list, num:int|float=1)

  • Selenium

    • Firefox(seleniumServer:str=None, PACFileURL:str=None, sessionID:str=None)
    • Chrome(seleniumServer:str=None, httpProxy:str=None, sessionID=None)
      • Except(*xpath:str, timeout:int=30) -> int | None
      • ResizeWindow(width:int, height:int)
      • ScrollRight(pixel:int)
      • ScrollLeft(pixel:int)
      • ScrollUp(pixel:int)
      • ScrollDown(pixel:int)
      • Url() -> str
      • Cookie() -> list[dict]
      • SetCookie(cookie_dict:dict)
      • Refresh()
      • GetSession() -> str
      • Get(url:str)
      • PageSource() -> str
      • Title() -> str
      • Close()
      • SwitchTabByID(number:int)
      • SwitchTabByIdent(ident:str)
      • Tabs() -> list[str]
      • NewTab() -> str
      • Find(xpath:str, timeout:int=60, scrollIntoElement:bool=True) -> SeleniumElement
        • Clear() -> SeleniumElement
        • Click() -> SeleniumElement
        • Text() -> str
        • Attribute(name:str) -> str
        • Input(string:str) -> SeleniumElement
        • Submit() -> SeleniumElement
        • PressEnter() -> SeleniumElement
        • ScrollIntoElement() -> SeleniumElement

  • Telegram(appid:str, apphash:str, sessionString:str=None)

    • SessionString() -> str
    • ResolvePeerByUsername(username:str) -> TelegramPeer | None
    • PeerByIDAndHash(ID:int, Hash:int, Type:str="channel") -> TelegramPeer | None
      • Resolve() # 如果手动根据ID初始化一个TelegramPeer实例, 调用这个函数可以补全这个ID对应的Peer的信息
      • SendMessage(message:str)
      • Messages(limit:int=100, offset:int=0) -> list[TelegramMessage]
      • Message(id:str) -> TelegramMessage
        • Refresh() -> TelegramMessage # 有时候同一个id, 被编辑了, 刷新一下返回最新的消息
        • ClickButton(buttonText:str) -> bool
        • Delete()

  • TelegramBotOfficial(token:str)

    • GetMe() -> telebot.types.User
    • SetChatID(chatid:int) -> TelegramBot
    • SetTags(*tags:str) -> TelegramBot
    • SendFile(path:str)
    • SendImage(path:str)
    • SendVideo(path:str)
    • SendAudio(path:str)
    • SendLocation(latitude:float, longitude:float)
    • SendMsg(msg:str, *tags:str)

  • ProgressBar(iterable_obj, total=None, title=None, leave=False)

  • Redis(host: str, port: int = 6379, database: int = 0, password: str = "")

    • Set(key:str, value:str, ttl:int=None) -> (bool | None)
    • Get(key:str) -> (str | None)
    • Del(key:str) -> int
    • Lock(key:str) -> RedisLock
      • Acquire()
      • Release()
    • Queue(key:str) -> RedisQueue
      • Size() -> int
      • Put(item:str)
      • Get(block=True, timeout=None) -> str

  • MySQL(host: str, port: int, user: str, password: str, database: str, prefix:str = "") # 跟5.7兼容. 因为orator跟5.7兼容, 跟8.0会有小问题, 作者很久不更新, 有空换掉这个orm. 注意, Python的MySQL操作不支持多线程, 需要每个线程连接一次MySQL, 不过这个是自动的, 在Get, Update等操作的时候如果链接异常就重连

  • SQLite(path: str, prefix:str = "") 由于SQLite每次只能一个线程进行操作, 所以这里默认会有一个锁, 线程安全

    • Queue(tbname:str, size:int=None) -> NamedQueue
      • Size() -> int
      • Get(wait=True) -> Any
      • Put(string:Any)
    • QueueConfirm(tbname:str, size:int=None, timeout:int=900) -> NamedConfirmQueue
      • Size() -> int
      • SizeStarted() -> int
      • SizeTotal() -> int
      • Get(wait=True) -> typing.Tuple[int, typing.Any]
      • Put(item:typing.Any)
      • Done(id:int)
    • Execute(sql: str) -> (bool | int | list)
    • Tables() -> list
    • Table(tbname: str) -> MySQLSQLiteTable
      • AddColumn(colname: str, coltype: str, default=None, nullable:bool = True) -> MySQLSQLiteTable
      • AddIndex(*cols: str) -> MySQLSQLiteTable
      • Fields(*cols: str) -> MySQLSQLiteTable
      • Where(key:str, opera:str, value:str) -> MySQLSQLiteTable
      • WhereIn(key:str, value: list) -> MySQLSQLiteTable
      • WhereNotIn(key:str, value: list) -> MySQLSQLiteTable
      • WhereNull(key:str) -> MySQLSQLiteTable
      • WhereNotNull(key:str) -> MySQLSQLiteTable
      • WhereBetween(key:str, start:int|float|str, end:int|float|str) -> MySQLSQLiteTable
      • WhereNotBetween(key:str, start:int|float|str, end:int|float|str) -> MySQLSQLiteTable
      • OrWhere(key:str, opera:str, value:str) -> MySQLSQLiteTable
      • OrWhereIn(key:str, value: list) -> MySQLSQLiteTable
      • OrderBy(*key:str) -> MySQLSQLiteTable
      • Limit(num:int) -> MySQLSQLiteTable
      • Paginate(size:int, page:int) -> MySQLSQLiteTable
      • Data(value:map) -> MySQLSQLiteTable
      • Offset(num:int) -> MySQLSQLiteTable
      • Insert()
      • Update()
      • Delete()
      • InsertGetID() -> int
      • Exists() -> bool
      • Count() -> int
      • Find(id:int) -> map
      • First() -> map
      • Get() -> list
      • Columns() -> list[map]
    • KeyValue(tbname:str)
      • Get(key:str) -> Any
      • Set(key:str, value:Any)
      • Del(key:str)
      • Keys() -> list[str]

其它的

• Thread(func, *args:Any, daemon:bool=True) -> threading.Thread # 启动线程, daemon=True
• Process(func, *args:Any, daemon:bool=True) -> multiprocessing.Process # 启动进程, daemon=True